sustainable-computing-io / kepler-doc

Kepler uses eBPF to probe energy related system stats and exports as Prometheus metrics
https://sustainable-computing.io/
Apache License 2.0
13 stars 37 forks source link

docs: cleanup code blocks in bullets #152

Closed Billy99 closed 3 months ago

Billy99 commented 3 months ago

New to Kepler and was trying to follow the documentation to install Kepler for the first time. The https://sustainable-computing.io/installation/kepler/#deploy-the-prometheus-operator section has several issues. Primarily, some of the code blocks lead with console in the text, new lines are not honored, and the bulleted numbers don't increment.

Fixes in this PR:

Billy99 commented 3 months ago

$ causes a lint error so I removed them. MD014/commands-show-output Dollar signs used before commands without showing output See: https://github.com/updownpress/markdown-lint/blob/master/rules/014-commands-show-output.md

Billy99 commented 3 months ago

Since @rootfs approved the original commit, made the following additional changes globally: