Changes to the templates for integrations (#15721)
Fotis Voutsas committed
Aug 3, 2023 at 16:07 UTC
e811d854c64b4ccc1a1bbc749f72230de875d3d8
2 files changed
+22
-5
integrations/templates/alerts.md
+5
@@ -1,4 +1,9 @@
1
+## Alerts
2
+
3
[% if entry.alerts %]
4
+
5
+The following alerts are available:
6
+
7
| Alert name | On metric | Description |
8
|:------------:|:---------:|:-----------:|
9
[% for alert in entry.alerts %]
integrations/templates/setup.md
+17
-5
@@ -3,8 +3,8 @@
3
[% if entry.setup.description %]
4
[[ entry.setup.description ]]
5
[% else %]
6
-[% if entry.setup.prerequisites.list %]
6
### Prerequisites
7
+[% if entry.setup.prerequisites.list %]
8
9
[% for prereq in entry.setup.prerequisites.list %]
10
#### [[ prereq.title ]]
@@ -12,12 +12,17 @@
12
[[ prereq.description ]]
13
14
[% endfor %]
15
+
16
+[% else %]
17
+
18
+No action required.
19
+
20
[% endif %]
16
-[% if entry.setup.configuration.file.name %]
21
### Configuration
22
23
#### File
24
25
+[% if entry.setup.configuration.file.name %]
26
The configuration file name for this integration is `[[ entry.setup.configuration.file.name ]]`.
27
[% if 'section_name' in entry.setup.configuration.file %]
28
Configuration for this specific integration is located in the `[[ entry.setup.configuration.file.section_name ]]` section within that file.
@@ -46,7 +51,9 @@ Netdata [config directory](https://github.com/netdata/netdata/blob/master/docs/c
51
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
52
sudo ./edit-config [[ entry.setup.configuration.file.name ]]
53
```
49
-
54
+[% else %]
55
+There is no configuration file.
56
+[% endif %]
57
#### Options
58
59
[[ entry.setup.configuration.options.description ]]
@@ -72,9 +79,12 @@ sudo ./edit-config [[ entry.setup.configuration.file.name ]]
79
[% if entry.setup.configuration.options.folding.enabled %]
80
{% /details %}
81
[% endif %]
82
+[% elif not entry.setup.configuration.options.description %]
83
+There are no configuration options.
84
+
85
[% endif %]
76
-[% if entry.setup.configuration.examples.list %]
86
#### Examples
87
+[% if entry.setup.configuration.examples.list %]
88
89
[% for example in entry.setup.configuration.examples.list %]
90
##### [[ example.name ]]
@@ -91,6 +101,8 @@ sudo ./edit-config [[ entry.setup.configuration.file.name ]]
101
{% /details %}
102
[% endif %]
103
[% endfor %]
94
-[% endif %]
104
+[% else%]
105
+There are no configuration examples.
106
+
107
[% endif %]
108
[% endif %]