Markdown linter (#1309)

* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
This commit is contained in:
Chevdor
2023-09-04 11:02:32 +02:00
committed by GitHub
parent 830fde2a60
commit a30092ab42
271 changed files with 6289 additions and 4450 deletions
+8 -4
View File
@@ -2,15 +2,19 @@
## Introduction
[Prometheus](https://prometheus.io/) is one of the most widely used monitoring tools for managing highly available services supported by [Cloud Native Computing Foundation](https://www.cncf.io/). By providing Prometheus metrics in Substrate, node operators can easily adopt widely used display/alert tools such
as [Grafana](https://grafana.com/) and [Alertmanager](https://prometheus.io/docs/alerting/alertmanager/). Easy access to such monitoring tools will benefit parachain developers/operators and validators to have much higher availability of their services.
[Prometheus](https://prometheus.io/) is one of the most widely used monitoring tools for managing highly available
services supported by [Cloud Native Computing Foundation](https://www.cncf.io/). By providing Prometheus metrics in
Substrate, node operators can easily adopt widely used display/alert tools such as [Grafana](https://grafana.com/) and
[Alertmanager](https://prometheus.io/docs/alerting/alertmanager/). Easy access to such monitoring tools will benefit
parachain developers/operators and validators to have much higher availability of their services.
Metrics will be served under `/metrics` on TCP port 9615 by default.
## Quick Start
1. From the root of the repository start Substrate `cargo run --release`.
2. In another terminal run `curl localhost:9615/metrics` to retrieve the metrics.
To learn how to configure Prometheus see the Prometheus [Getting Started](https://prometheus.io/docs/prometheus/latest/getting_started/) guide.
To learn how to configure Prometheus see the Prometheus [Getting
Started](https://prometheus.io/docs/prometheus/latest/getting_started/) guide.