The subsection Headings and Titles of this document contains a dos and don'ts table that was
not rendering correctly do to a few surplus line breaks inside the Markdown for the table.
This commit removes these spaces so the table renders correctly.
kubectl run starting from 1.18 is creating only Pods and there is no option to
create any other resource. Users should be using kubectl create
commands instead. This update the documentation in all those places
where kubectl create should be used instead or changes description to
reflect the situation.
* update style guide for styling component names
- Attempt to outline style conventions for components
and component tools
- Interested in comments and feedback
* update style examples
* style edits
- removed code style for components not cmd tools
- added style suggestion for namespaces
- cleaned up a few stray spaces
* Change the full link in the document to an inline link.
grep -r "https \: \ / \ / kubernetes \ .io" content/en/docs
Changed to inline link except the following list.
- URLs are mentioned directly in the body
- release note
- url to blog
- url to community
- Url to be redirected
* Apply suggestions from code review
Co-Authored-By: June Yi <june.yi@samsung.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>
* [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
* 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
Nate W
Charles Uneze
Kat Cosgrove
Tim Bannister
Aditya Samant
Qiming Teng
Karthik P M
Karthik-PM
AmarNathChary
Michael
Dipesh Rawat
Mauren Berti
Seokho Son
Shannon Kularathna
Kubernetes Prow Robot
Rishit Dagli
utkarsh-singh1
budhirajamadhav
Peter Sutter
Karen Bradshaw
Jordan Liggitt
Geoffrey Cline
Dan Roscigno
Casie Oxford
TAKAHASHI Shuuji
Qiming Teng
Maciej Szulik
Celeste Horgan
inductor
Yuk, Yongsu
PingWang
savitharaghunathan
aimeeu
Zach Corleissen
zhangqx2010
Rajakavitha1
Franklin Yu
Shashank Patel
Dani Comnea
June Yi