Closed Billy99 closed 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
Since @rootfs approved the original commit, made the following additional changes globally:
>Notes:
to !!! notes
as done in original commit.#
that were in code blocks that didn't require root access.kepler
to Kepler
were applicable.
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:
pymdownx.superfences
to themarkdown_extensions:
section inmkdocs.yml
. This fixed the newlines not honored in the indented code blocks and allowed the build to recognize the code block language identifier (console
).#
with a$
. To me,#
implies root access is required and none of the documented commands require root access. I will change this globally in the docs if this change is acceptable.admonition
to themarkdown_extensions:
section in mkdocs.yml. When adding things likeNote:
, withadmonition
, if!!! note
is used instead, it draws a box around the note. See https://squidfunk.github.io/mkdocs-material/reference/admonitions/. I can remove this, or update the docs globally depending on feedback.