From 4d3a7a315df7dd58fb458a1c5081c4d0536e3399 Mon Sep 17 00:00:00 2001 From: Andrew Chen Date: Mon, 26 Jun 2017 16:12:21 -0700 Subject: [PATCH] update example templates --- docs/concepts/example-concept-template.md | 8 ++++++++ docs/tasks/example-task-template.md | 13 +++++++++++++ docs/tutorials/example-tutorial-template.md | 15 +++++++++++++++ 3 files changed, 36 insertions(+) diff --git a/docs/concepts/example-concept-template.md b/docs/concepts/example-concept-template.md index c36fea402e14f..6fbd85751c395 100644 --- a/docs/concepts/example-concept-template.md +++ b/docs/concepts/example-concept-template.md @@ -1,14 +1,19 @@ --- 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 ... @@ -16,13 +21,16 @@ 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 %} \ No newline at end of file diff --git a/docs/tasks/example-task-template.md b/docs/tasks/example-task-template.md index 253a819994770..076aa08e20842 100644 --- a/docs/tasks/example-task-template.md +++ b/docs/tasks/example-task-template.md @@ -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 %} \ No newline at end of file diff --git a/docs/tutorials/example-tutorial-template.md b/docs/tutorials/example-tutorial-template.md index 1c2d9eb7149bb..d92d59310d886 100644 --- a/docs/tutorials/example-tutorial-template.md +++ b/docs/tutorials/example-tutorial-template.md @@ -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. @@ -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 %} \ No newline at end of file