Merge pull request #42337 from sftim/20230801_fix_codenew_advice

Fix explanation of custom code shortcode
pull/42383/head
Kubernetes Prow Robot 2023-08-03 21:06:21 -07:00 committed by GitHub
commit dacb005c1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions

View File

@ -271,9 +271,7 @@ Renders to:
{{< tab name="JSON File" include="podtemplate.json" />}}
{{< /tabs >}}
### Source code files
`{{%/* codenew */%}}` shortcode is replaced by `{{%/* code */%}}`.
## Source code files
You can use the `{{%/* code */%}}` shortcode to embed the contents of file in a code block to allow users to download or copy its content to their clipboard. This shortcode is used when the contents of the sample file is generic and reusable, and you want the users to try it out themselves.
@ -300,6 +298,9 @@ where `<RELATIVE-PATH>` is the path to the sample file to include, relative to t
{{%/* code file="configmap/configmaps.yaml" */%}}
```
The legacy `{{%/* codenew */%}}` shortcode is being replaced by `{{%/* code */%}}`.
Use `{{%/* code */%}}` in new documentation.
## Third party content marker
Running Kubernetes requires third-party software. For example: you