chrismetz09
da6826f5cc
Diagram-Guide: corrected Figure 10 caption
...
for Figure 10 in How to use captions section
2021-12-20 09:55:54 -08:00
Kubernetes Prow Robot
6f019208b8
Merge pull request #30299 from chrismetz09/metz-diagStyleGuide
...
Add Diagram Guide to Documentation Style Overview section
2021-12-17 03:40:29 -08:00
chrismetz09
f381db2d49
fixed typos
2021-12-15 15:30:28 -08:00
chrismetz09
e830abc8bd
refactored caption section and hyperlinked diagrams to live editor
2021-12-15 12:09:20 -08:00
chrismetz09
36bcc388cf
fixed colon typos
2021-12-09 12:11:25 -08:00
chrismetz09
5e17ad0f18
Add diagram guide
2021-12-09 11:44:05 -08:00
budhirajamadhav
fbeab275d0
Fix obsolete link to sig docs agenda doc
2021-11-23 03:12:10 +05:30
Tim Bannister
f5bb0c7e8a
Document thirdparty-content shortcode
2021-10-27 11:04:28 +01:00
Philippe Martin
7d0e235a99
Add shortcode doc
2021-09-14 15:51:58 +02:00
Tim Bannister
da31234d5d
Update docs for primary branch rename to "main"
2021-06-19 01:50:25 +01:00
Peter Sutter
5deefdaa9d
Switch Do's and Don'ts
2021-04-26 12:01:56 +02:00
Kubernetes Prow Robot
8de202cfa1
Merge pull request #26580 from kbhawkey/update-style-extraneous-words
...
update style guide (insensitive words)
2021-02-25 13:48:15 -08:00
Karen Bradshaw
e13661c5fe
update style guide
2021-02-16 19:14:13 -05:00
Jordan Liggitt
ec4df0f2cf
Address review comments
2021-02-14 15:50:12 -05:00
Geoffrey Cline
96c4813972
revise guidance for Pascal Case
2021-02-05 21:53:37 +00:00
Karen Bradshaw
0166a0b08e
add docs for version shortcodes
2021-01-12 17:20:33 -05:00
Dan Roscigno
64594a4c60
Correct camelcase of DaemonSet
2020-12-23 09:22:27 -05:00
Casie Oxford
826d53c81f
Update style guidelines for API object capitalization & formatting ( #23497 )
...
* Update style-guide.md
updates to api object handling according to SIG email discussion.
* Update content/en/docs/contribute/style/style-guide.md
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
* Update style-guide.md
updating API Object Examples
* Update content/en/docs/contribute/style/style-guide.md
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
* Update content/en/docs/contribute/style/style-guide.md
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
* Update content/en/docs/contribute/style/style-guide.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Zach Corleissen <zacharysarah@users.noreply.github.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
2020-09-27 13:10:48 -07:00
Kubernetes Prow Robot
f6ffc7c881
Merge pull request #23028 from sftim/20200808_fix_glossary_definition_shortcode
...
Fix glossary definition shortcode
2020-08-26 14:57:04 -07:00
Tim Bannister
c105f1a03a
Fix glossary definition shortcode
...
Fix a bug rendering short glossary definitions. Also, add an example
of a short glossary definition to the style guide.
2020-08-11 22:41:42 +01:00
TAKAHASHI Shuuji
c6a96128c4
Replace special quote characters with normal ones.
2020-08-11 21:05:22 +09:00
Qiming Teng
139da7d731
Tidy up: fix bad links in contribution guide
2020-07-20 09:53:11 +08:00
Kubernetes Prow Robot
8056a69b38
Merge pull request #22301 from kbhawkey/kb-example-content-move
...
create archetype files, _index cleanup
2020-07-06 03:42:50 -07:00
Jerry Park
64f62106c1
Fix issue of document link in some documents
2020-07-05 22:46:08 +09:00
Karen Bradshaw
0249f62e65
add docs about archetype pages
2020-07-03 11:03:05 -04:00
Maciej Szulik
00f502fa6a
Update kubectl run from docs where necessary
...
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.
2020-06-25 13:37:14 +02:00
makocchi-git
1862f2d961
update what's next contents
2020-06-18 13:10:10 +09:00
makocchi-git
2819a92dc0
update what's next contents
2020-06-18 13:04:31 +09:00
Karen Bradshaw
2451517bf1
add more content about headings
2020-06-12 08:30:04 -04:00
Karen Bradshaw
0bf1b10411
fix link, edit content
2020-06-10 16:06:05 -04:00
Karen Bradshaw
5fe8c3ca5e
move setup konnectivity svc
...
move api-access to extend-kubernetes
2020-06-10 16:06:01 -04:00
Karen Bradshaw
38250940c3
create page-content-types
2020-06-09 19:33:15 -04:00
Karen Bradshaw
ecc27bbbe7
add en pages
2020-06-09 19:33:15 -04:00
zacharysarah
549ae4d7e9
Clarify permitted content
2020-05-28 14:01:43 -07:00
Celeste Horgan
f0cded013f
Restructure to reduce duplication
...
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-04-07 12:25:56 -07:00
Heena-PyCloud
f8b863504a
This change has replaced &emdash; to — within the text (line 42).
2020-04-02 18:36:06 +05:30
Celeste Horgan
fbaeb89823
Fix markdown escaping ( #19744 )
...
Signed-off-by: Celeste Horgan <celeste@cncf.io>
2020-03-23 05:22:45 -07:00
Zach Corleissen
329c823aa6
KEP 1327: Apply feedback for third party and dual sourced content ( #19486 )
...
* Apply feedback for third party and dual sourced content
Add feedback from sftim
clarify which slack
* Limit third-party content to OSS
See https://github.com/kubernetes/enhancements/pull/1327#discussion_r392966251 for more discussion
2020-03-17 15:45:25 -07:00
inductor
4297f3b29c
Update nginx to modern versions ( #19198 )
...
* update nginx versions
* update
* update examples
2020-03-17 10:48:23 -07:00
Jacky Wu
05bf8be205
Federation Cleanup (1) doc: clean some outdate redirects and its associated content. ( #19572 )
...
* doc: clean some outdate redirects and its associated content.
* doc: also cleanup tasks.yml content.
2020-03-09 17:03:37 -07:00
Anshu Prateek
040df41846
change escaped chars to markdown ( #18858 )
...
Helps to keep doc clean for long term
2020-01-28 02:51:40 -08:00
Jie Shen
fb788cfba3
Fix typo in en/docs/contribute/style/content-guilde.md ( #18862 )
2020-01-27 01:35:05 -08:00
Sharjeel Aziz
2d410f35c5
Fix for a typo ( #18822 )
2020-01-24 08:30:32 -08:00
Xiang Dai
f21f4b2257
Fix en language misspell ( #18201 )
...
* fix misspell
Signed-off-by: Xiang Dai <764524258@qq.com>
* clean white noise
Signed-off-by: Xiang Dai <764524258@qq.com>
2019-12-20 06:49:32 -08:00
Karen Bradshaw
249f88c64e
update style guide for styling component names ( #17588 )
...
* 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
2019-12-02 02:21:04 -08:00
Yuk, Yongsu
d437e8c6bc
en: Change the full link in the document to an inline link. ( #17057 )
...
* 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>
2019-10-23 06:20:14 -07:00
PingWang
74397dd65f
Add the -n for pod in kubectl command ( #16798 )
...
Signed-off-by: PingWang <wang.ping5@zte.com.cn>
Add instructions in kubectl command
Signed-off-by: PingWang <wang.ping5@zte.com.cn>
update
Signed-off-by: PingWang <wang.ping5@zte.com.cn>
2019-10-11 18:28:39 -07:00
aimeeu
d80ab90cdb
Add references to Content guide alongside Style guide ( #16101 )
...
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>
2019-09-25 08:52:01 -07:00
Praveen Sastry
b2d803d71e
Rename `Flexvolume` to `FlexVolume` in docs ( #16333 )
2019-09-12 09:42:27 -07:00
savitharaghunathan
8f2d392fb5
Updating style.md and write-new-topic.md with markdowns ( #16190 )
2019-09-11 18:08:38 -07:00