Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-392

Fix section numbering in security docs on PV2

XMLWordPrintable

      Sections are numbered intentionally in upstream tutorials and how-tos to indicate sequence with `sectnums`.
      Downstream all chapters are numbered by default.

      Recap of problem:

      Quarkus upstream tutorials and how-to templates number sections that are part of the sequential procedure of that action goal.
      By default, section numbering (configured with reserved asciidoc attribute `sectnums` (formerly known as `numbering`) is DISABLED upstream, as per asciidoctor default configuration.

      Example:
      https://issues.redhat.com/secure/attachment/13006318/sectnumupstream.png

      BUT...

      In PV2 section numbering is enabled globally in attributes.adoc for Quarkus docs.
      Plus when you disable it in the global attributes file, PV2 still applies heading numbers to assemblies.

      This task is done when:

      Each security doc that needs section numbering is aligned with upstream section numbering.

      While assemblies are also working as per the default behavior for Red Hat downstream assemblies, whereby numbering is turned on by default for every chapter.

        1. image-2023-07-21-11-28-12-578.png
          4 kB
          Michelle Purcell
        2. sectnumupstream.png
          43 kB
          Michelle Purcell

              mpurcell@redhat.com Michelle Purcell
              mpurcell@redhat.com Michelle Purcell
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: