GH#553: Clarifying callout options to show more flexibility#593
Open
bergerhoffer wants to merge 1 commit into
Open
GH#553: Clarifying callout options to show more flexibility#593bergerhoffer wants to merge 1 commit into
bergerhoffer wants to merge 1 commit into
Conversation
Collaborator
Author
|
@IngridT1 @Preeticp Sorry for the extreme delay on getting this open. I re-reviewed the comments on the issue and our slack conversation from the fall. I think that @Preeticp's suggestion to just change "YAML file" to a more generic "code block" fixes our concerns with it seeming like you have to use the bulleted list option for YAML. Also as discussed in the slack thread, I adjusted the wording so that it doesn't say that you have to use "Specifies" exactly. I updated to match what the ISG recommends. Please let me know if you have any feedback. I've added a preview build in the description of the PR. |
This file contains hidden or 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
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.
Issue:
#553
Additional information:
Preview (VPN required): https://file.corp.redhat.com/~ahoffer/2024/main.html#explain-commands-variables-in-code-blocks
I made the following updates: