From 00151562145df50cc65e9902d52d5fa77f89fe50 Mon Sep 17 00:00:00 2001
From: Daniel Baumann <daniel.baumann@progress-linux.org>
Date: Thu, 9 Jun 2022 06:52:47 +0200
Subject: Merging upstream version 1.35.0.

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
---
 .../.page-level/_collector-page-template.mdx       | 68 ++++++++++++++++++++++
 .../.page-level/_concept-page-template.md          | 30 ++++++++++
 docs/.templates/.page-level/_task-page-template.md | 41 +++++++++++++
 .../.page-level/_tutorial-page-template.mdx        | 54 +++++++++++++++++
 4 files changed, 193 insertions(+)
 create mode 100644 docs/.templates/.page-level/_collector-page-template.mdx
 create mode 100644 docs/.templates/.page-level/_concept-page-template.md
 create mode 100644 docs/.templates/.page-level/_task-page-template.md
 create mode 100644 docs/.templates/.page-level/_tutorial-page-template.mdx

(limited to 'docs/.templates')

diff --git a/docs/.templates/.page-level/_collector-page-template.mdx b/docs/.templates/.page-level/_collector-page-template.mdx
new file mode 100644
index 000000000..fcbe7cec7
--- /dev/null
+++ b/docs/.templates/.page-level/_collector-page-template.mdx
@@ -0,0 +1,68 @@
+<!--
+title: $COLLECTOR_NAME monitoring with Netdata
+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
+
+import {
+	EnableCollector,
+	CollectorDebug,
+} from '@site/src/components/Collectors/_collector-components.jsx';
+
+Short description of what the collector does on a high level.
+Why should I use this collector?
+
+## Configuring $COLLECTOR_NAME
+
+#### Prerequisites
+
+List all needed prerequisites:
+
+- Prerequisite 1
+- Prerequisite 2
+- Prerequisite 3
+
+<CollectorConfiguration configURL="" moduleName="PLUGIN/COLLECTOR.conf" />
+
+### Example
+
+TODO: Check if we can automatically fetch the [JOBS] section of netdata.conf
+
+## Other configuration information
+
+Explain other configuration options, as needed.
+
+#### Prerequisites
+
+<!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
+
+Optional. List all needed prerequisites:
+
+- Prerequisite 1
+- Prerequisite 2
+- Prerequisite 3
+
+To do x:
+
+1. Step 1 written in active voice
+   ```bash
+   Code sample for step
+   ```
+2. Step 2
+   Result of step 2, for example a system reaction; written in passive voice
+3. Step 3
+
+## Debugging $COLLECTOR_NAME (optional)
+
+<CollectorDebug pluginName="" collectorName="" />
+
+## Metrics and Alerts produced by this collector
+
+| Chart      | Metrics     | Alert                    |
+| ---------- | ----------- | ------------------------ |
+| Chart Name | Metric name | [Alert 1](Link to alert) |
+| Chart Name | Metric name | [Alert 2](Link to alert) |
+| Chart Name | Metric name | [Alert 3](Link to alert) |
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. 
diff --git a/docs/.templates/.page-level/_task-page-template.md b/docs/.templates/.page-level/_task-page-template.md
new file mode 100644
index 000000000..0f49201e8
--- /dev/null
+++ b/docs/.templates/.page-level/_task-page-template.md
@@ -0,0 +1,41 @@
+<!--
+title: Starts with an active verb, like "Create a widget" or "Delete a widget"
+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
+
+Short description of why or when the procedure makes sense.
+
+## Subheading that describes the task
+#### Prerequisites
+<!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
+Optional. List all needed prerequisites: 
+- Prerequisite 1
+- Prerequisite 2
+- Prerequisite 3
+
+To do x:
+
+1. Step 1 written in active voice
+   ```bash
+   Code sample for step
+   ```
+2. Step 2
+   Result of step 2, for example a system reaction; written in passive voice
+3. Step 3
+
+## If needed, another task section 
+
+See lines 11-24
+
+<!-- Optional -->
+## What's next? 
+
+Optional section that explains the next logical steps.
+
+<!-- Optional -->
+## Related links 
+
+- Visit the [related thing documentation](www.related-thing.com) to learn more about related thing. 
diff --git a/docs/.templates/.page-level/_tutorial-page-template.mdx b/docs/.templates/.page-level/_tutorial-page-template.mdx
new file mode 100644
index 000000000..9f64b5ece
--- /dev/null
+++ b/docs/.templates/.page-level/_tutorial-page-template.mdx
@@ -0,0 +1,54 @@
+<!--
+title: Starts with an active verb, like "Create a widget" or "Delete a widget"
+description: Short summary (will be displayed in search engines)
+custom_edit_url: Edit URL of the source file
+author: "Your Name"
+author_title: "Your title at Netdata"
+author_img: "/img/authors/YourFace.jpg"
+keywords: [keywords, describing, the main topics]
+-->
+
+A paragraph that explains what the tutorial does, why it matters, and the expected outcome.
+
+To achieve goal:
+
+1. [Do the first task](#first-task)
+2. [Do the second task](#second-task)
+
+## Prerequisites
+
+<!-- If there is only one requirement, use a paragraph instead of a single bullet item. Bullets are social animals and only appear in groups of 2 or more :) -->
+
+Optional. List all needed prerequisites:
+
+- Prerequisite 1
+- Prerequisite 2
+- Prerequisite 3
+
+## First task
+
+To do x:
+
+1. Step 1 written in active voice
+   ```bash
+   Code sample for step
+   ```
+2. Step 2
+   Result of step 2, for example a system reaction; written in passive voice
+3. Step 3
+
+## Second task
+
+To do x:
+
+1. Step 1 written in active voice
+   ```bash
+   Code sample for step
+   ```
+2. Step 2
+   Result of step 2, for example a system reaction; written in passive voice
+3. Step 3
+
+## What's next?
+
+Optional section that explains the next logical steps.
-- 
cgit v1.2.3