80e6a832b0
Amend the style guide for line wrapping
...
We need to let contributors know that manual wrapping is a good
practice thus part of the style guide to make the lives of others
easier.
2023-10-02 20:54:20 +08:00
e8b136c3b3
Use code_sample shortcode instead of code shortcode
2023-09-05 17:10:14 +08:00
eb9db45aa3
Merge pull request #41987 from sftim/20230712_revise_home_page
...
Revise docs home page
2023-08-15 21:22:27 -07:00
9520b96a61
Revise docs home page
...
Reorder and replace cards to better (I hope!) serve our readers.
2023-08-09 11:49:12 +01:00
29178c6a3b
Update style-guide.md
2023-08-07 22:54:38 +05:30
dc9e07cb03
added .editorconfig
2023-08-05 16:39:52 +05:30
27d65c1456
Fix explanation of custom code shortcode
2023-08-02 00:44:54 +01:00
f5388a1efe
Add code shortcode to replace codenew
2023-07-27 17:27:26 +08:00
eb522c126f
Replace {{< codenew ... >}} with {{% codenew ... %}} in all English docs ( #42180 )
...
* Replaced {{< codenew ... >}} with {{% codenew ... %}} in all files
* Reverted changes in non-english localizations
2023-07-25 05:54:06 -07:00
ae69059fb1
fixed buggy example note shortcode
2023-06-21 13:29:17 +05:30
1ec7fe8e63
Tweak line wrappings in content-organization.md
2023-06-01 21:49:31 +08:00
252bcf6c29
Adapt Kubernetes basics tutorials for local use
...
Avoid relying on Katacoda.
Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-03-28 15:23:31 +01:00
73bfd0ec56
[en] update hugo config file
2023-03-19 00:56:47 +02:00
e7e4de3a0f
Added info for <codenew> shortcode in style guide ( #39764 )
...
* Add info for codenew shortcode in style guide
Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>
* Update content/en/docs/contribute/style/style-guide.md
Co-authored-by: Tim Bannister <tim@scalefactory.com>
* Addressed feedback comments
Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>
* Update content/en/docs/contribute/style/hugo-shortcodes/index.md
Co-authored-by: Brad Topol <btopol@us.ibm.com>
* Update content/en/docs/contribute/style/hugo-shortcodes/index.md
Co-authored-by: Brad Topol <btopol@us.ibm.com>
---------
Signed-off-by: Dipesh Rawat <Dipesh.rawat@ibm.com>
Co-authored-by: Tim Bannister <tim@scalefactory.com>
Co-authored-by: Brad Topol <btopol@us.ibm.com>
2023-03-08 05:37:12 -08:00
e16623fb96
fix: remove excessive line breaks in headings and titles section.
...
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.
2023-02-26 17:06:50 -05:00
c098f10604
Update content/en/docs/contribute/style/write-new-topic.md
2022-10-30 20:07:29 +05:30
35ebbd1e41
Update page weights for pages in content/en/docs/contribute
2022-10-25 01:09:47 +09:00
e688bb87bb
Add title case style guideline
2022-09-21 20:54:48 +00:00
73def14e96
Revise content-organization.md
2022-09-20 13:27:12 +09:00
6810fa976d
Merge remote-tracking branch 'upstream/main' into dev-1.25
2022-08-18 15:58:41 -03:00
b167938367
Scrub PSP docs for 1.25
2022-08-15 21:09:41 -04:00
8183d5a62d
Fix the extra '{' or '}'
...
Signed-off-by: ydFu <ader.ydfu@gmail.com>
2022-08-14 15:36:13 +08:00
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
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
989e8ac98c
Add clarification about API resources to the Style Guide
2022-07-23 18:37:34 +00:00
ed58f048b9
Fix typo
2022-07-14 23:59:07 +01:00
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
70ace47f66
Updated the style-guide doc
...
Signed-off-by: utkarsh-singh1 <utkarsh.singh1@india.nec.com>
2022-07-13 21:55:32 +05:30
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
649328ac2f
Use JavaScript instead of Javascript
2022-04-24 11:54:22 +08:00
1e87ec875d
Merge pull request #31627 from tengqm/tune-diagram-guide
...
Reformat diagram guide
2022-02-11 08:48:25 -08:00
6ea009fa04
Wrap long lines for hugo-shortcodes page
2022-02-05 14:57:39 +08:00
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
da6826f5cc
Diagram-Guide: corrected Figure 10 caption
...
for Figure 10 in How to use captions section
2021-12-20 09:55:54 -08:00
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
f381db2d49
fixed typos
2021-12-15 15:30:28 -08:00
e830abc8bd
refactored caption section and hyperlinked diagrams to live editor
2021-12-15 12:09:20 -08:00
36bcc388cf
fixed colon typos
2021-12-09 12:11:25 -08:00
5e17ad0f18
Add diagram guide
2021-12-09 11:44:05 -08:00
fbeab275d0
Fix obsolete link to sig docs agenda doc
2021-11-23 03:12:10 +05:30
f5bb0c7e8a
Document thirdparty-content shortcode
2021-10-27 11:04:28 +01:00
7d0e235a99
Add shortcode doc
2021-09-14 15:51:58 +02:00
da31234d5d
Update docs for primary branch rename to "main"
2021-06-19 01:50:25 +01:00
5deefdaa9d
Switch Do's and Don'ts
2021-04-26 12:01:56 +02:00
8de202cfa1
Merge pull request #26580 from kbhawkey/update-style-extraneous-words
...
update style guide (insensitive words)
2021-02-25 13:48:15 -08:00
e13661c5fe
update style guide
2021-02-16 19:14:13 -05:00
ec4df0f2cf
Address review comments
2021-02-14 15:50:12 -05:00
96c4813972
revise guidance for Pascal Case
2021-02-05 21:53:37 +00:00
0166a0b08e
add docs for version shortcodes
2021-01-12 17:20:33 -05:00
64594a4c60
Correct camelcase of DaemonSet
2020-12-23 09:22:27 -05:00
Qiming Teng
Mengjiao Liu
Kubernetes Prow Robot
Tim Bannister
Karthik P M
Karthik-PM
Andrey Goran
AmarNathChary
Michael
Arhell
Dipesh Rawat
Mauren Berti
kadtendulkar
Seokho Son
Shannon Kularathna
bconfiden2
carolina valencia
Jordan Liggitt
ydFu
Rishit Dagli
utkarsh-singh1
chrismetz09
Sean Wei
budhirajamadhav
Philippe Martin
Peter Sutter
Karen Bradshaw
Geoffrey Cline
Dan Roscigno