Skip to content

Latest commit

 

History

History
88 lines (63 loc) · 3.39 KB

smoketest.md

File metadata and controls

88 lines (63 loc) · 3.39 KB
Raw

Hidden smoketest page

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.

Below are a set of site elements that have causes issues in the past.

Lists

  • Top level:
    1. A nested list item.
      1. another level lower
    2. Nested code sample:
      Shortcode: {{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}}
      Example: {{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}}
    3. This should be the third bullet (3.).
      1. More nested code:
        Shortcode: {{< readfile file="Gopkg.toml" code="true" lang="toml" >}}
        Example: {{< readfile file="Gopkg.toml" code="true" lang="toml" >}}
      2. Another nested ordered list item (2.)

Code samples

The following use the readfile shortcode

Shortcode: {{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}} renders as: {{< readfile file="./hack/reference-docs-gen-config.json" code="true" lang="json" >}}

Shortcode: {{< readfile file="./docs/serving/samples/cloudevents/cloudevents-nodejs/service.yaml" code="true" lang="yaml" >}} renders as: {{< readfile file="./docs/serving/samples/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 (uses the define values from config/_default/params.toml)

  1. Shortcode: {{< version >}} renders as: {{< version >}}

    Example: kubectl apply version/{{< version >}}/is-the-latest/docs-version.yaml

  2. Shortcode: {{< version override="v0.2.2" >}} renders as: {{< version override="v0.2.2" >}}

    Example: kubectl apply the-version-override/{{< version override="v0.2.2" >}}/is-manually-specified.yaml

  3. Shortcode: {{< version patch=".20" >}} renders as: {{< version patch=".20" >}}

    Example: kubectl apply this-is-a-point-release/{{< version patch=".20" >}}/filename.yaml

  4. Shortcode: {{< branch >}} renders as: {{< branch >}}

    Example: git clone -b "{{< branch >}}" https://github.com/knative/docs knative-docs

  5. Shortcode: {{< branch override="release-0.NEXT" >}} 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.

View this file in GitHub

{{< tabs name="tabs_example" default="Include example" >}} {{< tab name="Regular example" >}} This is a regular example tab. {{< /tab >}}

{{< tab name="Include example" >}} {{% readfile file="./docs/serving/samples/multi-container/service.yaml" code="true" lang="yaml" %}} {{< /tab >}} {{< /tabs >}}