Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Ellipses yaml code blocks #519

Merged
merged 1 commit into from
Oct 9, 2024
Merged

Ellipses yaml code blocks #519

merged 1 commit into from
Oct 9, 2024

Conversation

apinnick
Copy link
Contributor

@apinnick apinnick commented Oct 7, 2024 •
edited
Loading

Issue: None

Additional information: Review comments in #517

@apinnick apinnick closed this Oct 7, 2024
@apinnick apinnick reopened this Oct 7, 2024
@apinnick apinnick force-pushed the ellipses-yaml-code-blocks branch from 170a867 to 7c9dbca Compare October 7, 2024 09:33
@apinnick apinnick force-pushed the ellipses-yaml-code-blocks branch from 7c9dbca to baef5c3 Compare October 7, 2024 09:34
ndeevy
ndeevy approved these changes Oct 7, 2024
View reviewed changes
Copy link
Contributor

@ndeevy ndeevy left a comment

Choose a reason for hiding this comment

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

LGTM

@bredamc
Copy link
Contributor

bredamc commented Oct 8, 2024

@apinnick Just to explain my request to show both the code and the rendered output for the example -- it's not clear to me whether the workaround of prefixing the ellipsis with # will render the ellipsis correctly in the output, or comment it out so that it is no longer visible?

@apinnick
Copy link
Contributor Author

apinnick commented Oct 9, 2024 •
edited
Loading

@apinnick Just to explain my request to show both the code and the rendered output for the example -- it's not clear to me whether the workaround of prefixing the ellipsis with # will render the ellipsis correctly in the output, or comment it out so that it is no longer visible?

This is not a workaround. It's standard YAML.

The # will always render because it is inside a code block. See the examples in OCP doc guidelines.

bredamc
bredamc approved these changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@bredamc bredamc left a comment

Choose a reason for hiding this comment

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

LGTM

@bredamc bredamc merged commit ae59c8d into redhat-documentation:main Oct 9, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bredamc bredamc bredamc approved these changes

@dfitzmau dfitzmau dfitzmau approved these changes

@ndeevy ndeevy ndeevy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@apinnick @bredamc @ndeevy @dfitzmau