Enhance to emphasize that triagers should add a priority to each
issue.
Add Learn about Prow section
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add references to the Content guide where the Style guide was
mentioned.
Update the Contribute page (_index.md)
Make Style and Content linkable everywhere
Changed bullet list to numbered list in Content Guide to make referring
to sections easier.
Reverted change to bullet list - beyond scope of this PR
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add new section for content guidelines
Add table of examples of what is and is not allowed
Add examples of links to Linux Academy courses based on discussion
during the Aug 20 SIG Docs meeting.
Remove example table and reformat based on feedback
Move content guide to its own page
Update existing pages to mention new Content Guide page
Signed-off-by: Aimee Ukasick <aimeeu.opensource@gmail.com>
Add hyperlink to 'communicate' in Participating in SIG Docs section.
Hyperlink points to Participating in SIG Docs discussions section further down the page.
Add info to Submit a pull request bullet 5 about putting fixes #<issue_number>
or closes #<issue_number> to the PR description so GitHub will automatically close the issue
* Update api reference contrib doc
See issue #14111
* updates to api ref contrib guide
* further updates to api ref contrib
* more updates api ref contrib
* [WIP] added accessibility guidelines to the style guide
Adopted the accessibility level A and AA guidelines to Markdown elements:
https://www.w3.org/WAI/WCAG21/quickref/?versions=2.0¤tsidebar=%23col_overview&levels=aaa
We still need to define attributes for the front matter. See, https://github.com/kubernetes/website/issues/14286
I am yet to draft the guidelines for images and alt text.
* fixed the note
Update style-guide.md
Incorporated the changes suggested
Incorporated the changes suggested.
fixed the formatting issues in the table
fixed the spaces in the links section
fixed a space issue
fixed format issues in the link
added a11y guidelines to code section
removed a spacing issue
front matter guidelines best fit the using template section
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
incorporated the changes
incorporated the changes
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
title section for front matter guideline
updated the html characters
Update content/en/docs/contribute/style/style-guide.md
Co-Authored-By: Tim Bannister <tim@scalefactory.com>
Update style-guide.md
Add meeting guidelines, graphic
Update embedded image
Use raw HTML for image link
Edit path
Indent list items
minor edits
Add line breaks for indentation
Add bolding
Add section for meetings
Feedback from jimangel
* Add Setting up the OWNERS files section
* Update OWNERS_ALIASES patch
* Replace owners.md link with go.k8s.io/owners
* Replace github.com/kubernetes link with git.k8s.io
* Update OWNERS_ALIASES to use git.k8s.io link
* Sort patch diff in alphabetical order
* Specify clearly what teams should be added
* Remove the passive voice
* Complete alphabetical order phrase
Plain language rocks
Remove an orphaned line
Remove note
Present tense rocks
Add repository
Feedback, round 1
Add team descriptions
Add Slack link
Feedback, part 2
Feedback from gochist
Remove link
* Revise guide for generating reference docs
This PR changes the guidance for generating reference documentation for
Kubernetes API and kubernetes components. The topic of making changes to
the upstream repo is separated out because 1) it is not a mandatory step
for generating the reference docs; 2) it is about a more advanced level
of documentation fix.
* light copyedit
* more light copyedits
* fix note shortcode, lists
- fix note shortcode for use in lists
- add example in style guide
* add more items to list
* update warning, caution, minor tweaks
* more updates
Roy Hvaara
Jim Angel
aimeeu
Karen Bradshaw
Praveen Sastry
savitharaghunathan
Kaitlyn Barnard
Max Kaminskiy
Jared
Zach Corleissen
Tim Bannister
Ellen Mei
zhangqx2010
Rajakavitha1
codyc
Luc Perkins
June Yi
Franklin Yu
Yang Li
shavidissa
Rael Garcia
chenrui
Danny Berger
Qiming
Shashank Patel