kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #48755 from nate-double-u/style-guide-follow-up 

Correcting Style Guide Headings and Titles section
pull/48759/head
Kubernetes Prow Robot 2024-11-18 20:38:55 +00:00 committed by GitHub
parent 6325a083dc f3ba85a033
commit 1f58a96b1e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
content/en/docs/contribute/style/style-guide.md
View File

@ -511,7 +511,7 @@ Use pound or hash signs (`#`) for non-blog post content. | Use underlines (`---`
Use sentence case for headings in the page body. For example, **Extend kubectl with plugins** | Use title case for headings in the page body. For example, **Extend Kubectl With Plugins**
Use title case for the page title in the front matter. For example, `title: Kubernetes API Server Bypass Risks` | Use sentence case for page titles in the front matter. For example, don't use `title: Kubernetes API server bypass risks`
Place relevant links in the body copy. | Include hyperlinks (`<a href=""></a>`) in headings.
Use proper heading markers (`---` or `===`) to indicate headings. | Use **bold** text or other indicators to split paragraphs.
Use pound or hash signs (`#`) to indicate headings. | Use **bold** text or other indicators to split paragraphs.
{{< /table >}}
### Paragraphs
@ -701,4 +701,4 @@ the rest of the project. To view the file, refer to
* Learn about [writing a new topic](/docs/contribute/style/write-new-topic/).
* Learn about [using page templates](/docs/contribute/style/page-content-types/).
* Learn about [custom hugo shortcodes](/docs/contribute/style/hugo-shortcodes/).
* Learn about [creating a pull request](/docs/contribute/new-content/open-a-pr/).
* Learn about [creating a pull request](/docs/contribute/new-content/open-a-pr/).