Commit Graph

103 Commits

Author SHA1 Message Date
kadtendulkar c098f10604 Update content/en/docs/contribute/style/write-new-topic.md 2022-10-30 20:07:29 +05:30
Seokho Son 35ebbd1e41 Update page weights for pages in content/en/docs/contribute 2022-10-25 01:09:47 +09:00
Shannon Kularathna e688bb87bb Add title case style guideline 2022-09-21 20:54:48 +00:00
bconfiden2 73def14e96 Revise content-organization.md 2022-09-20 13:27:12 +09:00
carolina valencia 6810fa976d Merge remote-tracking branch 'upstream/main' into dev-1.25 2022-08-18 15:58:41 -03:00
Jordan Liggitt b167938367 Scrub PSP docs for 1.25 2022-08-15 21:09:41 -04:00
ydFu 8183d5a62d Fix the extra '{' or '}'
Signed-off-by: ydFu <ader.ydfu@gmail.com>
2022-08-14 15:36:13 +08:00
Kubernetes Prow Robot c932262b65
Merge pull request #35119 from Rishit-dagli/Rishit-dagli-api-resources-style
Add clarification about API resources to the Style Guide
2022-07-25 00:18:58 -07:00
Kubernetes Prow Robot 7078c38d3b
Merge pull request #33792 from sftim/20220510_assign_pod_node_affinity_updates
Revise scheduling-related docs
2022-07-24 03:38:57 -07:00
Rishit Dagli 989e8ac98c Add clarification about API resources to the Style Guide 2022-07-23 18:37:34 +00:00
Tim Bannister ed58f048b9 Fix typo 2022-07-14 23:59:07 +01:00
Tim Bannister 6700656cb4 Move Pod Topology Spread Constraints into scheduling
These constraints apply specifically to the mechanism for placing Pods
onto nodes (that is, scheduling).
2022-07-14 23:59:05 +01:00
utkarsh-singh1 70ace47f66 Updated the style-guide doc
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2022-07-13 21:55:32 +05:30
chrismetz09 5fb97e57a4
mermaid shortcode mentioned in Note causes error
Couple of Notes in the [Diagram Guide](https://kubernetes.io/docs/contribute/style/diagram-guide/) include mention of the Hugo Mermaid shortcode. This generates a syntax error. Appears that Hugo interprets this as a Mermaid diagram.

```
{{< note >}}
You must include the `{{</*  mermaid */>}}`, `{{</* /mermaid */>}}` shortcode
tags at the start and end of the Mermaid code block. You should add a diagram
caption below the diagram. 
{{< /note >}}

```

This PR removes the `{{< mermaid >}}` mention inside the `{{< note >}} so that Hugo does not attempt to render a diagram.
2022-06-28 11:19:41 -07:00
Sean Wei 649328ac2f Use JavaScript instead of Javascript 2022-04-24 11:54:22 +08:00
Kubernetes Prow Robot 1e87ec875d
Merge pull request #31627 from tengqm/tune-diagram-guide
Reformat diagram guide
2022-02-11 08:48:25 -08:00
Qiming Teng 6ea009fa04 Wrap long lines for hugo-shortcodes page 2022-02-05 14:57:39 +08:00
Qiming Teng 439ef1f84f Reformat diagram guide
This PR wraps the long lines in the diagram guide for ease of change tracking.
It also fixes some link targets to use relative paths.
2022-02-05 12:01:47 +08:00
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