mudhorn/node_exporter
1
0
Fork 0
mirror of https://github.com/prometheus/node_exporter.git synced 2024-12-25 21:54:18 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix the following markdownlint issues (#2362)

Browse source 
fix the following markdownlint errors (and some more):

[..]mixins/node-exporter/README.md:13: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:21: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:27: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:33: MD031 Fenced code blocks should be surrounded by blank lines
[..]mixins/node-exporter/README.md:41: MD034 Bare URL used
A detailed description of the rules is available at https://github.com/markdownlint/markdownlint/blob/master/docs/RULES.md

Signed-off-by: Sven Kieske <s.kieske@mittwald.de>
This commit is contained in:
Sven Kieske 2022-06-28 05:50:06 +02:00 committed by GitHub
parent d2b8ee8f20
commit d64766f43d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/node-mixin/README.md
View file

@ -10,33 +10,36 @@ for Grafana.
To use them, you need to have `jsonnet` (v0.16+) and `jb` installed. If you To use them, you need to have `jsonnet` (v0.16+) and `jb` installed. If you
have a working Go development environment, it's easiest to run the following: have a working Go development environment, it's easiest to run the following:
```bash ```bash
$ go install github.com/google/go-jsonnet/cmd/jsonnet@latest go install github.com/google/go-jsonnet/cmd/jsonnet@latest
$ go install github.com/google/go-jsonnet/cmd/jsonnetfmt@latest go install github.com/google/go-jsonnet/cmd/jsonnetfmt@latest
$ go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest go install github.com/jsonnet-bundler/jsonnet-bundler/cmd/jb@latest
``` ```
Next, install the dependencies by running the following command in this Next, install the dependencies by running the following command in this
directory: directory:
```bash ```bash
$ jb install jb install
``` ```
You can then build the Prometheus rules files `node_alerts.yaml` and You can then build the Prometheus rules files `node_alerts.yaml` and
`node_rules.yaml`: `node_rules.yaml`:
```bash ```bash
$ make node_alerts.yaml node_rules.yaml make node_alerts.yaml node_rules.yaml
``` ```
You can also build a directory `dashboard_out` with the JSON dashboard files You can also build a directory `dashboard_out` with the JSON dashboard files
for Grafana: for Grafana:
```bash ```bash
$ make dashboards_out make dashboards_out
``` ```
Note that some of the generated dashboards require recording rules specified in Note that some of the generated dashboards require recording rules specified in
the previously generated `node_rules.yaml`. the previously generated `node_rules.yaml`.
For more advanced uses of mixins, see For more advanced uses of mixins, see
https://github.com/monitoring-mixins/docs. <https://github.com/monitoring-mixins/docs>.