-
Notifications
You must be signed in to change notification settings - Fork 39
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: cleanup code blocks in bullets #152
Merged
rootfs
merged 2 commits into
sustainable-computing-io:main
from
Billy99:billy99-bullet-code-block
May 2, 2024
Merged
docs: cleanup code blocks in bullets #152
rootfs
merged 2 commits into
sustainable-computing-io:main
from
Billy99:billy99-bullet-code-block
May 2, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rootfs
approved these changes
May 1, 2024
Billy99
force-pushed
the
billy99-bullet-code-block
branch
from
May 2, 2024 01:56
1da30b9
to
099edf4
Compare
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: * Added `pymdownx.superfences` to the `markdown_extensions:` section in `mkdocs.yml`. This fixed the newlines not honored in the indented code blocks and allowed the build to recognize the code block language identifier (`console`). * Added additional spaces to the code blocks in bulleted sections. This indents the code block to the same level as the text and allows the bulleted numbers to increment properly. * For code blocks, replaced `#` with a `$`. To me, `#` implies root access is required and and none of the documented commands require root access. I will change this globally in the docs if this change is acceptable. `$` causes a lint error so I removed them. `MD014/commands-show-output Dollar signs used before commands without showing output` * Added `admonition` to the `markdown_extensions:` section in mkdocs.yml. When adding things like `Note:`, with `admonition`, is `!!! note` is used, 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. * Changed the default language to English. When building and running locally, it defaulted to Chinese. The problem is that only 3 of the pages are translated into Chinese so it looked like it was in English except for those 3 pages on the table of content. So took a while to figure out that the language for the whole website was set to Chinese and that there wasn't some other issue. Signed-off-by: Billy McFall <22157057+Billy99@users.noreply.github.com>
|
This can be squashed once reviewed. Additional changes: * Globally updated `>Notes: to `!!! notes` as done in original commit. * Globally removed `# ` that were in code blocks that didn't require root access. * Globally indented code blocks in bullet items so the code block matched up with the bullet text. * Changed all `kepler` to `Kepler` were applicable. * Fixed typos or bad grammer as they were stumbled upon. Signed-off-by: Billy McFall <22157057+Billy99@users.noreply.github.com>
Billy99
force-pushed
the
billy99-bullet-code-block
branch
from
May 2, 2024 17:05
099edf4
to
298f1a4
Compare
Since @rootfs approved the original commit, made the following additional changes globally:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.