Contribute to Kubernetes docs

Edit This Page

Using Page Templates

When contributing new topics, apply one of the following templates to them. This standardizes the user experience of a given page.

The page templates are in the layouts/partials/templates directory of the kubernetes/website repository.

Note: Every new topic needs to use a template. If you are unsure which template to use for a new topic, start with the concept template.

Concept template

A concept page explains some aspect of Kubernetes. For example, a concept page might describe the Kubernetes Deployment object and explain the role it plays as an application once it is deployed, scaled, and updated. Typically, concept pages don’t include sequences of steps, but instead provide links to tasks or tutorials.

To write a new concept page, create a Markdown file in a subdirectory of the /content/en/docs/concepts directory, with the following characteristics:

Annotations is a published example of the concept template. This page also uses the concept template.

Task template

A task page shows how to do a single thing, typically by giving a short sequence of steps. Task pages have minimal explanation, but often provide links to conceptual topics that provide related background and knowledge.

To write a new task page, create a Markdown file in a subdirectory of the /content/en/docs/tasks directory, with the following characteristics:

An example of a published topic that uses the task template is Using an HTTP proxy to access the Kubernetes API.

Tutorial template

A tutorial page shows how to accomplish a goal that is larger than a single task. Typically a tutorial page has several sections, each of which has a sequence of steps. For example, a tutorial might provide a walkthrough of a code sample that illustrates a certain feature of Kubernetes. Tutorials can include surface-level explanations, but should link to related concept topics for deep explanations.

To write a new tutorial page, create a Markdown file in a subdirectory of the /content/en/docs/tutorials directory, with the following characteristics:

An example of a published topic that uses the tutorial template is Running a Stateless Application Using a Deployment.

What's next

Feedback