Spacer Title

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:

     {
         "hideMemberFields": [
             "TypeMeta"
         ],
         "hideTypePatterns": [
             "ParseError$",
             "List$"
         ],
         "externalPackages": [
             {
                 "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$",
                 "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"
             },
             {
                 "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
                 "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
             },
             {
                 "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/",
                 "docsURLTemplate": "https://godoc.org/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}"
             }
         ],
         "typeDisplayNamePrefixOverrides": {
             "k8s.io/api/": "Kubernetes ",
             "k8s.io/apimachinery/pkg/apis/": "Kubernetes "
         },
         "markdownDisabled": false
     }
     

  3. This should be the third bullet (3.).
     1. More nested code:
        Shortcode: {{< readfile file="Gopkg.toml” code="true” lang="toml” >}}
        Example:

        Something's not right. The Gopkg.toml file was not found.

     2. Another nested ordered list item (2.)

Code samples

The following use the readfile shortcode

{
    "hideMemberFields": [
        "TypeMeta"
    ],
    "hideTypePatterns": [
        "ParseError$",
        "List$"
    ],
    "externalPackages": [
        {
            "typeMatchPrefix": "^k8s\\.io/apimachinery/pkg/apis/meta/v1\\.Duration$",
            "docsURLTemplate": "https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#Duration"
        },
        {
            "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/",
            "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.18/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}"
        },
        {
            "typeMatchPrefix": "^github\\.com/knative/pkg/apis/duck/",
            "docsURLTemplate": "https://godoc.org/github.com/knative/pkg/apis/duck/{{arrIndex .PackageSegments -1}}#{{.TypeIdentifier}}"
        }
    ],
    "typeDisplayNamePrefixOverrides": {
        "k8s.io/api/": "Kubernetes ",
        "k8s.io/apimachinery/pkg/apis/": "Kubernetes "
    },
    "markdownDisabled": false
}

Something's not right. The Gopkg.toml file was not found.

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 %}}

   Example: kubectl apply version/Archives.0/is-the-latest/docs-version.yaml

2. Shortcode: {{% version override="v0.2.2” %}}

   Example: kubectl apply the-version-override/v0.2.2/is-manually-specified.yaml

3. Shortcode: {{% version patch=”.20” %}}

   Example: kubectl apply this-is-a-point-release/Archives.20/filename.yaml

4. Shortcode: {{% branch %}}

   Example: git clone -b "" https://github.com/knative/docs knative-docs

5. Shortcode: {{% branch override="release-0.NEXT” %}}

   Example: git clone -b "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 the raw version of this page for example syntax; it doesn’t render well here.)

• Regular example
• Include example