📖 Change formatting in the "Catalog queries" doc #1461
Merged
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
✅ Deploy Preview for olmv1 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
openshift-ci
bot
added
the
do-not-merge/work-in-progress
m1kola
force-pushed
the
change_catalog-queries_formatting
branch
3 times, most recently
from
514ec17 to
71a6373
Compare
This commit adds definition lists for placeholders such as `<package_name>`. The goal of adding definition lists for placeholders is to improve their visibility in the code snippets. This commit also switches existing definition lists [1] (list of queries) to unordered list. The current list of queries uses definition lists from mkdocs-material. However it relies on a tailing space after a colon to work. E.g. the whole line becomes `: ` and it is prone to errors because: 1. It is easy to overlook a space which is part of markdown. 2. Many editors remove tailing spaces at the end of lines. 3. We are adding more definition lists into this docs to explain placeholders such as `<package_name>`. With nested definition lists markdown of this document going to be very difficult to manage. [1]: https://squidfunk.github.io/mkdocs-material/reference/lists/#using-definition-lists Signed-off-by: Mikalai Radchuk <[email protected]>
m1kola
force-pushed
the
change_catalog-queries_formatting
branch
from
71a6373 to
97bf635
Compare
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
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.
Description
This commit adds definition lists for placeholders such as
<package_name>. The goal of adding definition lists for placeholders is to improve their visibility in the code snippets.This commit also switches existing definition lists 1 (list of queries) to unordered list. The current list of queries uses definition lists from mkdocs-material. However it relies on a tailing space after a colon to work. E.g. the whole line becomes
:and it is prone to errors because:<package_name>. With nested definition lists markdown of this document going to be very difficult to manage.Tip
We also have docs deployment preview. See the comment from netlify bot below.
See: preview of this PR vs live version
Tip
Recommend reviewing the changes with
git diff --ignore-all-space(-w) option. GitHub UI also has this option.Reviewer Checklist