mirror of
https://github.com/netdata/netdata.git
synced 2025-04-13 01:08:11 +00:00
Docs templates (#12466)
* Add concept template * Add task template * commit pending changes bc I need to switch branch * Upload set of templates for discussion * Amend templates based on feedback * Refinements * Rename _concept-template.md to _concept-page-template.md
This commit is contained in:
parent
71286c1336
commit
dffa33f83d
4 changed files with 193 additions and 0 deletions
docs/.templates/.page-level
68
docs/.templates/.page-level/_collector-page-template.mdx
Normal file
68
docs/.templates/.page-level/_collector-page-template.mdx
Normal file
|
@ -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) |
|
30
docs/.templates/.page-level/_concept-page-template.md
Normal file
30
docs/.templates/.page-level/_concept-page-template.md
Normal file
|
@ -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.
|
41
docs/.templates/.page-level/_task-page-template.md
Normal file
41
docs/.templates/.page-level/_task-page-template.md
Normal file
|
@ -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.
|
54
docs/.templates/.page-level/_tutorial-page-template.mdx
Normal file
54
docs/.templates/.page-level/_tutorial-page-template.mdx
Normal file
|
@ -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.
|
Loading…
Add table
Reference in a new issue