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.

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

Change the layout of the next steps #893

Merged
merged 2 commits into from
Feb 17, 2025

Conversation

jmagak
Copy link
Member

@jmagak jmagak commented Jan 30, 2025

Changing the outlook from
image
to something like what we have here,
image

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s): 1.4, 1.3

Add the relevant labels to the Pull Request.
Issue:

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Jan 30, 2025

Copy link
Member

@themr0c themr0c left a comment

Choose a reason for hiding this comment

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

I do not understand the intention.

The current source is a an unordered list. See https://docs.asciidoctor.org/asciidoc/latest/lists/unordered/

For a Next steps section, an unordered list appear to be expected. See https://redhat-documentation.github.io/modular-docs/#next-steps

Adding blank spaces at the beginning of the line transforms the line in a literal block. https://docs.asciidoctor.org/asciidoc/latest/verbatim/literal-blocks/

@jmagak
Copy link
Member Author

jmagak commented Feb 7, 2025

I do not understand the intention.

The current source is a an unordered list. See https://docs.asciidoctor.org/asciidoc/latest/lists/unordered/

For a Next steps section, an unordered list appear to be expected. See https://redhat-documentation.github.io/modular-docs/#next-steps

Adding blank spaces at the beginning of the line transforms the line in a literal block. https://docs.asciidoctor.org/asciidoc/latest/verbatim/literal-blocks/

Thanks, @themr0c, for these insights. As you pointed out, the intention was to have the Next steps in a literal block rather than just a general list. I will revert these changes, as I also noticed the formatting in past documents.

@jmagak jmagak force-pushed the Change-the-next-step-layout branch from 902264b to 72f2e24 Compare February 7, 2025 20:54
@jmagak jmagak requested a review from themr0c February 7, 2025 21:07
@themr0c themr0c merged commit 33f16cb into redhat-developer:main Feb 17, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants