Skip to content

GH#553: Clarifying callout options to show more flexibility#593

Open
bergerhoffer wants to merge 1 commit into
redhat-documentation:mainfrom
bergerhoffer:callout-clarification
Open

GH#553: Clarifying callout options to show more flexibility#593
bergerhoffer wants to merge 1 commit into
redhat-documentation:mainfrom
bergerhoffer:callout-clarification

Conversation

@bergerhoffer
Copy link
Copy Markdown
Collaborator

@bergerhoffer bergerhoffer commented May 19, 2026

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:

  • In the bulleted list option, changed "YAML file" to "code block", so that it doesn't seem like you have to use the bulleted list for all YAML blocks
  • In the description list option, removed the rule that says descriptions must start exactly with "Specifies". And instead allowed more flexibility - pulled in the guidance from the ISG that says it can be a full sentence, or a fragment starting either with a noun phrase or a third-person verb (such as "Specifies")

@bergerhoffer
Copy link
Copy Markdown
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.

Copy link
Copy Markdown
Collaborator

@IngridT1 IngridT1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I'll let @Preeticp take a look at it before I merge it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants