patternfly / patternfly-quickstarts

Repository containing the PatternFly Quick Start extension code
MIT License
15 stars 39 forks source link

Notes in general text are not shown in the UI #105

Closed bredamc closed 2 years ago

bredamc commented 2 years ago

Admonitions (Note, Tip, Important, Caution, Warning) in general text are shown only in the generated HTML, and are not shown in the UI version of the document.

If the admonition is in a numbered list, it is rendered correctly in both the generated HTML and in the UI.

The AsciiDoc admonition syntax is described here: https://docs.asciidoctor.org/asciidoc/latest/blocks/admonitions/

jschuler commented 2 years ago

Looks like they don't render correctly when not in a list, I tried it out by adding these admonitions to the alert-note-prereq/README.adoc:

NOTE: If NOTE you want to use a service account that already has the required role, you can skip this section.

Tip:

TIP: If TIP you want to use a service account that already has the required role, you can skip this section.

Important:

IMPORTANT: If IMPORTANT you want to use a service account that already has the required role, you can skip this section.

Caution:

CAUTION: If CAUTION you want to use a service account that already has the required role, you can skip this section.

Warning:

WARNING: If WARNING you want to use a service account that already has the required role, you can skip this section.
CooperRedhat commented 2 years ago

Hi @bredamc do you mind sharing an example asciidoc file where you saw this issue occur? Taking a look.

jschuler commented 2 years ago

I shared with @CooperRedhat the file you sent me, he'll be working on a fix

bredamc commented 2 years ago

@jschuler @CooperRedhat Thank you both :)