Skip to content

Commit c6a64fc

Browse files
committed
Add metadata section to example template bodies
1 parent ba0fe6e commit c6a64fc

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

docs/templatedemos/index.md

Lines changed: 31 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,13 +83,23 @@ e.g. `docs/your-concept-name/index.md`.
8383

8484
```liquid{% raw %}
8585
---
86+
objects:
87+
- list_of_concepts
88+
- fields_and_tools
89+
- that_are_the_focus
90+
concepts:
91+
- list_of_concepts: 10
92+
- fields_and_tools: 20
93+
- that_are_used: 30
94+
- with_a_sort_order: 15
95+
advanced: false
8696
---
87-
{% capture concept %}{% endcapture %}
88-
{% capture what_is %}{% endcapture %}
89-
{% capture when_to_use %}{% endcapture %}
90-
{% capture when_not_to_use %}{% endcapture %}
91-
{% capture status %}{% endcapture %}
92-
{% capture usage %}{% endcapture %}
97+
{% capture concept %} concept-name-here {% endcapture %}
98+
{% capture what_is %} description-of-concept-here {% endcapture %}
99+
{% capture when_to_use %} when-to-user-here {% endcapture %}
100+
{% capture when_not_to_use %} anti-patterns-here {% endcapture %}
101+
{% capture status %} how-to-get-with-kubectl-here {% endcapture %}
102+
{% capture usage %} yaml-config-usage-here {% endcapture %}
93103
{% include templates/concept-overview.md %}
94104
{% endraw %}```
95105
@@ -120,18 +130,29 @@ e.g. `docs/tasks/your-task-name`.
120130
121131
### Adding the Template sections
122132
123-
- tags
133+
- metadata: structured description of the doc content
124134
- purpose: one sentence description of the task and motivation
125135
- recommended_background: List of Concepts referenced or other Tasks, Tutorials that provide needed context
126136
- set_by_step: Add multiple sections. 1 per step in the task.
127137
- template: include the template at the end
128138
129139
```liquid{% raw %}
130140
---
141+
synopsis: "one sentence description of task."
142+
objects:
143+
- list_of_concepts
144+
- fields_and_tools
145+
- that_are_the_focus
146+
concepts:
147+
- list_of_concepts: 10
148+
- fields_and_tools: 20
149+
- that_are_used: 30
150+
- with_a_sort_order: 15
151+
advanced: false
131152
---
132-
{% capture purpose %}{% endcapture %}
133-
{% capture recommended_background %}{% endcapture %}
134-
{% capture step_by_step %}{% endcapture %}
153+
{% capture purpose %} task-description-here {% endcapture %}
154+
{% capture recommended_background %} prereq-reading-here {% endcapture %}
155+
{% capture step_by_step %} single-step-here {% endcapture %}
135156
{% include templates/task.md %}
136157
{% endraw %}```
137158

0 commit comments

Comments
 (0)