@@ -83,13 +83,23 @@ e.g. `docs/your-concept-name/index.md`.
83
83
84
84
``` liquid{% raw %}
85
85
---
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
86
96
---
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 %}
93
103
{% include templates/concept-overview.md %}
94
104
{% endraw %}```
95
105
@@ -120,18 +130,29 @@ e.g. `docs/tasks/your-task-name`.
120
130
121
131
### Adding the Template sections
122
132
123
- - tags
133
+ - metadata: structured description of the doc content
124
134
- purpose: one sentence description of the task and motivation
125
135
- recommended_background: List of Concepts referenced or other Tasks, Tutorials that provide needed context
126
136
- set_by_step: Add multiple sections. 1 per step in the task.
127
137
- template: include the template at the end
128
138
129
139
```liquid{% raw %}
130
140
---
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
131
152
---
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 %}
135
156
{% include templates/task.md %}
136
157
{% endraw %}```
137
158
0 commit comments