Skip to content

Commit

Permalink
Merge pull request #4197 from kubernetes/chenopis-task-template-patch
Browse files Browse the repository at this point in the history
update example templates
  • Loading branch information
chenopis authored Jun 26, 2017
2 parents d8a8d8d + 4d3a7a3 commit 56ae8bf
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/concepts/example-concept-template.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
---
title: Example Concept Template
assignees:
- chenopis
---

{% capture overview %}

**NOTE:** Be sure to also [create an entry in the table of contents](/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents) for your new document.

This page explains ...

{% endcapture %}

{% capture body %}

## Understanding ...

Kubernetes provides ...

## Using ...

To use ...

{% endcapture %}

{% capture whatsnext %}

**[Optional Section]**

* Learn more about [Writing a New Topic](/docs/home/contribute/write-new-topic/).
* See [Using Page Templates - Concept template](/docs/home/contribute/page-templates/#concept_template) for how to use this template.

{% endcapture %}

{% include templates/concept.md %}
13 changes: 13 additions & 0 deletions docs/tasks/example-task-template.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,50 @@
---
title: Example Task Template
assignees:
- chenopis
---

{% capture overview %}

**NOTE:** Be sure to also [create an entry in the table of contents](/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents) for your new document.

This page shows how to ...

{% endcapture %}

{% capture prerequisites %}

* {% include task-tutorial-prereqs.md %}
* Do this.
* Do this too.

{% endcapture %}

{% capture steps %}

## Doing ...

1. Do this.
1. Do this next. Possibly read this [related explanation](...).

{% endcapture %}

{% capture discussion %}

## Understanding ...
**[Optional Section]**

Here's an interesting thing to know about the steps you just did.

{% endcapture %}

{% capture whatsnext %}

**[Optional Section]**

* Learn more about [Writing a New Topic](/docs/home/contribute/write-new-topic/).
* See [Using Page Templates - Task template](/docs/home/contribute/page-templates/#task_template) for how to use this template.

{% endcapture %}

{% include templates/task.md %}
15 changes: 15 additions & 0 deletions docs/tutorials/example-tutorial-template.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,35 @@
---
title: Example Tutorial Template
assignees:
- chenopis
---

{% capture overview %}

**NOTE:** Be sure to also [create an entry in the table of contents](/docs/home/contribute/write-new-topic/#creating-an-entry-in-the-table-of-contents) for your new document.

This page shows how to ...

{% endcapture %}

{% capture prerequisites %}

* {% include task-tutorial-prereqs.md %}
* Do this.
* Do this too.

{% endcapture %}

{% capture objectives %}

* Learn this.
* Build this.
* Run this.

{% endcapture %}

{% capture lessoncontent %}

## Building ...

1. Do this.
Expand All @@ -32,20 +42,25 @@ This page shows how to ...

## Understanding the code
Here's something interesting about the code you ran in the preceding steps.

{% endcapture %}

{% capture cleanup %}

**[Optional Section]**

* Delete this.
* Stop this.

{% endcapture %}

{% capture whatsnext %}

**[Optional Section]**

* Learn more about [Writing a New Topic](/docs/home/contribute/write-new-topic/).
* See [Using Page Templates - Tutorial template](/docs/home/contribute/page-templates/#tutorial_template) for how to use this template.

{% endcapture %}

{% include templates/tutorial.md %}

0 comments on commit 56ae8bf

Please sign in to comment.