summaryrefslogtreecommitdiffstats
path: root/docs/.templates/.page-level/_concept-page-template.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2022-06-09 04:52:47 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2022-06-09 04:52:57 +0000
commit00151562145df50cc65e9902d52d5fa77f89fe50 (patch)
tree2737716802f6725a5074d606ec8fe5422c58a83c /docs/.templates/.page-level/_concept-page-template.md
parentReleasing debian version 1.34.1-1. (diff)
downloadnetdata-00151562145df50cc65e9902d52d5fa77f89fe50.tar.xz
netdata-00151562145df50cc65e9902d52d5fa77f89fe50.zip
Merging upstream version 1.35.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r--docs/.templates/.page-level/_concept-page-template.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/.templates/.page-level/_concept-page-template.md b/docs/.templates/.page-level/_concept-page-template.md
new file mode 100644
index 000000000..685dd2ff3
--- /dev/null
+++ b/docs/.templates/.page-level/_concept-page-template.md
@@ -0,0 +1,30 @@
+<!--
+title: Noun that describes the concept
+description: Short summary (will be displayed in search engines)
+custom_edit_url: Edit URL of the source file
+keywords: [keywords, describing, the main topics]
+-->
+
+# Title
+
+Why should the reader care: “What’s in it for me?”
+
+## Subheading
+
+Ideally, try to explain one core idea per section. Questions that you could keep in mind while writing:
+
+- How does it work?
+- What are the outcomes?
+- What are the positive and negative effects of it?
+- Are there alternatives that provide a similar result?
+
+## Subheading
+
+Add more subheadings and anything else that needs to be explained...
+Remember, if you start to describe about another concept, stop yourself.
+Each concept should be about one concept only.
+
+<!-- Optional -->
+### Related links
+<!-- Here, you could include links to task topic that describe how to implement the thing you discussed in this concept. -->
+- Visit the [related thing documentation](www.related-thing.com) to learn more about related thing.