mirror of https://github.com/knative/docs.git
88 lines
3.4 KiB
Markdown
88 lines
3.4 KiB
Markdown
# Hidden smoketest page
|
|
|
|
<!-- is this page still needed? -->
|
|
Use this page to test your changes and ensure that there are not any issues,
|
|
unwanted behaviors, or regression that are caused by your changes.
|
|
|
|
This is a set of site elements that have causes issues in the past:
|
|
|
|
## Lists
|
|
|
|
- Top level:
|
|
1. A nested list item.
|
|
1. another level lower
|
|
1. Nested code sample: <br>Syntax: <code>{<code>{< readfile
|
|
file="../code-samples/community/serving/helloworld-java-quarkus/service.yaml"
|
|
code="true" lang="yaml" >}</code>}</code> <br>Example:
|
|
{{< readfile file="../code-samples/community/serving/helloworld-java-quarkus/service.yaml" code="true" lang="yaml" >}}
|
|
1. This should be the third bullet (3.).
|
|
1. More nested code: <br>Shortcode: <code>{<code>{< readfile
|
|
file="/code-samples/serving/hello-world/helloworld-go/Dockerfile" code="true"
|
|
lang="go" >}</code>}</code> <br>Example:
|
|
{{< readfile file="./code-samples/serving/hello-world/helloworld-go/Dockerfile" code="true" lang="go" >}}
|
|
1. Another nested ordered list item (2.)
|
|
|
|
## Code samples
|
|
|
|
The following use the
|
|
[`readfile` shortcode](https://github.com/knative/website/blob/main/layouts/shortcodes/readfile.md)
|
|
|
|
Shortcode: <code>{<code>{< readfile file="../hack/reference-docs-gen-config.json" code="true" lang="json" >}</code>}</code>
|
|
renders as:
|
|
{{< readfile file="../hack/reference-docs-gen-config.json" code="true" lang="json" >}}
|
|
|
|
Shortcode: <code>{<code>{< readfile file="./code-samples/serving/cloudevents/cloudevents-nodejs/service.yaml" code="true" lang="yaml" >}</code>}</code>
|
|
renders as:
|
|
{{< readfile file="./code-samples/serving/cloudevents/cloudevents-nodejs/service.yaml" code="true" lang="yaml" >}}
|
|
|
|
|
|
## Install version numbers and Clone branch commands
|
|
|
|
Examples of how the manual and dynamic version number or branch name can be
|
|
added in-line with the
|
|
[`version` shortcode](https://github.com/knative/website/blob/main/layouts/shortcodes/version.md)
|
|
(uses the define values from
|
|
[config/\_default/params.toml](https://github.com/knative/website/blob/main/config/_default/params.toml))
|
|
|
|
1. Shortcode: <code>{<code>{< version >}</code>}</code>
|
|
renders as: {{< version >}}
|
|
|
|
Example:
|
|
`kubectl apply version/{{< version >}}/is-the-latest/docs-version.yaml`
|
|
|
|
1. Shortcode: <code>{<code>{< version override="v0.2.2" >}</code>}</code>
|
|
renders as: {{< version override="v0.2.2" >}}
|
|
|
|
Example:
|
|
`kubectl apply the-version-override/{{< version override="v0.2.2" >}}/is-manually-specified.yaml`
|
|
|
|
1. Shortcode: <code>{<code>{< version patch=".20" >}</code>}</code>
|
|
renders as: {{< version patch=".20" >}}
|
|
|
|
Example:
|
|
`kubectl apply this-is-a-point-release/{{< version patch=".20" >}}/filename.yaml`
|
|
|
|
1. Shortcode: <code>{<code>{< branch >}</code>}</code>
|
|
renders as: {{ branch }}
|
|
|
|
Example:
|
|
`git clone -b "{{ branch }}" https://github.com/knative/docs knative-docs`
|
|
|
|
1. Shortcode: <code>{<code>{< branch override="release-0.NEXT" >}</code>}</code>
|
|
renders as: {{< branch override="release-0.NEXT" >}}
|
|
|
|
Example:
|
|
`git clone -b "{{< branch override="release-0.NEXT" >}}" https://github.com/knative/docs knative-docs`
|
|
|
|
## Tabs
|
|
|
|
How to include tabbed content in your page. Note that you can set a default tab.
|
|
|
|
|
|
{{< tab name="Regular example" >}}
|
|
This is a regular example tab.
|
|
|
|
|
|
{{< tab name="Include example" >}}
|
|
{{% readfile file="./code-samples/serving/multi-container/service.yaml" code="true" lang="yaml" %}}
|