* 'master' of https://github.com/kubernetes/kubernetes.github.io:
  Remove instructions to stage from <username>github.io. (#3893)
  Add drop-in templates
This commit is contained in:
Andrew Chen
2017-05-25 12:31:24 -07:00
5 changed files with 119 additions and 18 deletions
+28
View File
@@ -0,0 +1,28 @@
---
title: Example Concept Template
---
{% 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 %}
@@ -14,24 +14,6 @@ Create a fork of the Kubernetes documentation repository as described in
{% capture steps %}
## Staging from your GitHub account
GitHub provides staging of content in your master branch. Note that you
might not want to merge your changes into your master branch. If that is
the case, choose another option for staging your content.
1. In your GitHub account, in your fork, merge your changes into
the master branch.
1. Change the name of your repository to `<your-username>.github.io`, where
`<your-username>` is the username of your GitHub account.
1. Delete the `CNAME` file.
1. View your staged content at this URL:
https://<your-username>.github.io
## Staging a pull request
When you create a pull request, either against the master or &lt;vnext&gt;
+37
View File
@@ -0,0 +1,37 @@
---
title: Example Task Template
---
{% 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 %}
* 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 %}
@@ -0,0 +1,51 @@
---
title: Example Tutorial Template
---
{% 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 %}
* Do this.
* Do this too.
{% endcapture %}
{% capture objectives %}
* Learn this.
* Build this.
* Run this.
{% endcapture %}
{% capture lessoncontent %}
## Building ...
1. Do this.
1. Do this next. Possibly read this [related explanation](...).
## Running ...
1. Do this.
1. Do this next.
## 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 %}
+3
View File
@@ -27,6 +27,7 @@ docs/admin/resourcequota/walkthrough.md
docs/admin/static-pods.md
docs/admin/sysctls.md
docs/api-reference/labels-annotations-taints.md
docs/concepts/example-concept-template.md
docs/concepts/abstractions/pod-termination.md
docs/contribute/README.md
docs/contribute/create-pull-request.md
@@ -44,6 +45,8 @@ docs/reference/deprecation-policy.md
docs/search.md
docs/sitemap.md
docs/tabs-example.md
docs/tasks/example-task-template.md
docs/tutorials/example-tutorial-template.md
docs/user-guide/accessing-the-cluster.md
docs/user-guide/annotations.md
docs/user-guide/application-troubleshooting.md