Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Create a Style Guide #6

Closed
JasonMorgan opened this issue Feb 5, 2021 · 2 comments · Fixed by #38
Closed

Create a Style Guide #6

JasonMorgan opened this issue Feb 5, 2021 · 2 comments · Fixed by #38
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Milestone
v1

Comments

@JasonMorgan
Copy link
Collaborator

Build, publish, and maintain a style guide so that new folks can more easily contribute.
@JasonMorgan JasonMorgan added this to the v1 milestone Feb 5, 2021
@JasonMorgan JasonMorgan added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Feb 5, 2021
@JasonMorgan JasonMorgan mentioned this issue Feb 7, 2021
Merged
@JasonMorgan
Copy link
Collaborator Author

A couple items I'd like to see, the big one being a definitive template for entries and an explanation for every property. An example: I put in a category property for each entry but as of right now the only value I can think of is concept. Either we should have more categories or remove that property.

@IdealUsrname
Copy link
Contributor

I've completed a basic outline for a style guide. Just waiting for the acceptance of #31, So I don't have to change the format again :)

IdealUsrname added a commit that referenced this issue Feb 17, 2021
@IdealUsrname
First pass for the style guide
5055be3 
Solving for #6 

I added some extra categories. Would love feedback on formatting.
@IdealUsrname IdealUsrname mentioned this issue Feb 17, 2021
Merged
IdealUsrname added a commit that referenced this issue Feb 21, 2021
@IdealUsrname @CathPag
First pass for the style guide (#38)
773dd3a 
* First pass for the style guide

Solving for #6 

I added some extra categories. Would love feedback on formatting.

* Update style-guide.md

Fixed two typos and a spacing issue

* Removed multiple categories.

A discussion should be created around how categories will be used.

Co-authored-by: CathPag <74001907+CathPag@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Milestone
v1
Development

Successfully merging a pull request may close this issue.

First pass for the style guide cncf/glossary
2 participants
@JasonMorgan @IdealUsrname