From 6dba587d1928fd4cc6e179ef8dc4fc093d57ac6f Mon Sep 17 00:00:00 2001 From: steveperry-53 Date: Mon, 9 Jan 2017 16:27:41 -0800 Subject: [PATCH] Add instructions for putting title in front matter. --- docs/contribute/write-new-topic.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/contribute/write-new-topic.md b/docs/contribute/write-new-topic.md index fc03159d24..3ecae45674 100644 --- a/docs/contribute/write-new-topic.md +++ b/docs/contribute/write-new-topic.md @@ -54,6 +54,17 @@ URL for the topic, for example: http://kubernetes.io/docs/tasks/access-kubernetes-api/http-proxy-access-api/ +### Adding the topic title to the front matter + +In your topic, put a `title` field in the +[front matter](https://jekyllrb.com/docs/frontmatter/). +The front matter is the YAML block that is between the +triple-dashed lines at the top of the page. Here's an example: + + --- + title: Using an HTTP Proxy to Access the Kubernetes API + --- + ### Choosing a directory Depending on your page type, put your new file in a subdirectory of one of these: @@ -73,6 +84,10 @@ Depending page type, create an entry in one of these files: * /_data/tutorials.yaml * /_data/concepts.yaml +Here's an example of an entry in /_data/tasks.yaml: + + - docs/tasks/configure-pod-container/configure-volume-storage.md + ### Including code from another file To include a code file in your topic, place the code file in the Kubernetes