Skip to content

Commit d886d65

Browse files
authored
Merge pull request #29957 from sftim/20211007_document_thirdparty-content_shortcode
Document {{% thirdparty-content %}} shortcode
2 parents e35a6e1 + f5bb0c7 commit d886d65

File tree

1 file changed

+37
-0
lines changed
  • content/en/docs/contribute/style/hugo-shortcodes

1 file changed

+37
-0
lines changed

content/en/docs/contribute/style/hugo-shortcodes/index.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -242,6 +242,43 @@ Renders to:
242242
{{< tab name="JSON File" include="podtemplate.json" />}}
243243
{{< /tabs >}}
244244

245+
## Third party content marker
246+
247+
Running Kubernetes requires third-party software. For example: you
248+
usually need to add a
249+
[DNS server](/docs/tasks/administer-cluster/dns-custom-nameservers/#introduction)
250+
to your cluster so that name resolution works.
251+
252+
When we link to third-party software, or otherwise mention it,
253+
we follow the [content guide](/docs/contribute/style/content-guide/)
254+
and we also mark those third party items.
255+
256+
Using these shortcodes adds a disclaimer to any documentation page
257+
that uses them.
258+
259+
### Lists {#third-party-content-list}
260+
261+
For a list of several third-party items, add:
262+
```
263+
{{%/* thirdparty-content */%}}
264+
```
265+
just below the heading for the section that includes all items.
266+
267+
### Items {#third-party-content-item}
268+
269+
If you have a list where most of the items refer to in-project
270+
software (for example: Kubernetes itself, and the separate
271+
[Descheduler](https://github.com/kubernetes-sigs/descheduler)
272+
component), then there is a different form to use.
273+
274+
Add the shortcode:
275+
```
276+
{{%/* thirdparty-content single="true" */%}}
277+
```
278+
279+
before the item, or just below the heading for the specific item.
280+
281+
245282
## Version strings
246283

247284
To generate a version string for inclusion in the documentation, you can choose from

0 commit comments

Comments
 (0)