ci: Add markdownlint GH workflow #72
Conversation
spetrosi
force-pushed
the
markdownlint-init
branch
2 times, most recently
from
4994ef5
to
3a7d2f4
Compare
Add markdownlint GH workflow and config file to check all .md files
spetrosi
force-pushed
the
markdownlint-init
branch
from
3a7d2f4
to
4f66bb1
Compare
roles/pcp/README.md
Outdated
| pcp_explicit_labels: | ||
| ### pcp_pmlogger_interval: 10 | ||
| ### pcp_optional_agents: [dm, nfsclient, openmetrics] | ||
| ### pcp_explicit_labels: | ||
| environment: production |
There was a problem hiding this comment.
not sure what markdownlint was complaining about here, but these should not be commented out
There was a problem hiding this comment.
Indentation by 4 spaces is a different variant of code block markdown. Markdownlint then complaining about the usual code block formatting because it wants us to use the same syntax consistently.
If you look at the original doc, this code block synatx looks weird. Subtitles suit better here.
There was a problem hiding this comment.
You're right, it was some incorrect mass replace on my side. Now it's fixed.
roles/pcp/README.md
Outdated
| ### pcp_pmlogger_interval: 10 | ||
| ### pcp_pmlogger_discard: 5 | ||
| ### pcp_target_hosts: [slip, slop, slap] | ||
| ### pcp_rest_api: true |
There was a problem hiding this comment.
not sure what markdownlint was complaining about here, but these should not be commented out
There was a problem hiding this comment.
Agreed, this looks like the same issue as above and the change seems incorrect here.
roles/spark/README.md
Outdated
| @@ -53,7 +53,7 @@ Setup export of PCP metrics to a Spark worker thread. | |||
| roles: | |||
| - role: performancecopilot.metrics.spark | |||
| vars: | |||
| spark_export_port: 44388 | |||
| ### spark_export_port: 44388 | |||
There was a problem hiding this comment.
not sure what markdownlint was complaining about here, but these should not be commented out
There was a problem hiding this comment.
Yep, same again here - this is an example, and should not be commented like this.
spetrosi
force-pushed
the
markdownlint-init
branch
from
8614cf2
to
e98b968
Compare
|
Enhancement: Add markdownlint GH workflow and config file to check all .md files
Reason: Ensure that all markdown files have correct syntax and will be build correctly.