Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions content/en/docs/contribute/style/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -545,6 +545,21 @@ Write hyperlinks that give you context for the content they link to. For example
Write Markdown-style links: `[link text](URL)`. For example: `[Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions)` and the output is [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/#table-captions). | Write HTML-style links: `<a href="/media/examples/link-element-example.css" target="_blank">Visit our tutorial!</a>`, or create links that open in new tabs or windows. For example: `[example website](https://example.com){target="_blank"}`
{{< /table >}}

### Linking to the Cloud Native Glossary

The [CNCF Cloud Native Glossary](https://glossary.cncf.io/) defines
cloud native terms in plain language, with little assumed context. Where
a term in the Kubernetes documentation has a corresponding Cloud Native Glossary entry,
linking to it helps newer readers without disrupting more experienced ones.

{{< table caption = "Do and Don't - Linking to the Cloud Native Glossary" >}}
Do | Don't
:--| :-----
Link to the Cloud Native Glossary on the first occurrence of a term per page. | Link every occurrence of a term throughout the page.
Link when the glossary entry adds useful context beyond what the Kubernetes documentation provides. | Link when the glossary definition duplicates or conflicts with Kubernetes-specific explanations.
Add a "Further reading" reference in a glossary entry's `longDescription` pointing to the Cloud Native Glossary equivalent. | Replace the Kubernetes Glossary definition with a link to the Cloud Native Glossary.
{{< /table >}}

### Lists

Group items in a list that are related to each other and need to appear in a specific
Expand Down
2 changes: 2 additions & 0 deletions content/en/docs/reference/glossary/cncf.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,5 @@ Kubernetes is a CNCF project.
The CNCF is a sub-foundation of [the Linux Foundation](https://www.linuxfoundation.org/).
Its mission is to make cloud native computing ubiquitous.

The CNCF also maintains the [Cloud Native Glossary](https://glossary.cncf.io/),
a reference for cloud native terminology aimed at anyone new to the field.