* 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 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>
* [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
* Copy-edit based on the style guide
Made the following changes:
- Used present tense.
- Removed latin phrases
- {{< tab name=“Content File #1” include=“example1” />}} was not shown as code. Updated it.
- Copy-edited the description for include under Tabs.
* Updated the text based on the comments
* Capitalized "Pod" in multiple locations
This style guide states to always capitalize Pod, but in the next section it was written in lowercase in a couple places. I've capitalized them.
* Capitalized two additional instances of "Pod" as recommended by @neolit123
* Copyedit and update with escape characters
- Use escape characters for {{< toc >}}.
- Copyedit the content.
* Remove the {{< toc >}} reference
The template does not need a {{< toc >}} as the TOC will be generated by default. Therefore, removed this info from the doc.
* Copyedit the page
A few minor updates were made.
* Update conjuction
Three options. The first (original) was OK, the second (change in this PR) was ambiguous, the third is a bit clearer.
It was not clear what "Before you begin" meant and how it needs to be added only if the task or tutorial is version specific. Therefore, added this info in.
Celeste Horgan
Heena-PyCloud
Zach Corleissen
inductor
Jacky Wu
Anshu Prateek
Jie Shen
Sharjeel Aziz
Xiang Dai
Karen Bradshaw
Yuk, Yongsu
PingWang
aimeeu
Praveen Sastry
savitharaghunathan
zhangqx2010
Rajakavitha1
Luc Perkins
Franklin Yu
Shashank Patel
chenrui
Dani Comnea
Neha Yadav
June Yi
shavidissa
MengZeLee
alex-libre
Cody Clark
CaoShuFeng
Misty Linville
Julie Bruce
Sam Foo