Uploaded image for project: 'Quarkus'
  1. Quarkus
  2. QUARKUS-4522

Applying the QE feedback to the Logging guide

XMLWordPrintable

      This PR is an application of the QE review @michalvavrik has provided me several weeks ago. This is part of the revision of all RHBQ docs, the fixes of which needs to be applied "Upstream first".

      While most of changes are general review and suggestions, we have one footnote issue here, since the newer Asciidoc footnote macro applied in the Logging guide doesn't work in RHBQ docs, thanks to the obsolete version of the bccutil.
      We can push any updates there or request any maintenance. Thus, I asked @jmartisk for a SED that would search n replace all these footnotes and put them in their older shape, that still works well in Upstream (based on my local test and build I made). @gsmet Guiilame, I wrote you about this in an email last weak or so. Do you think we can keep it as it is or you would prefer to add this SED command to our downstreaming script so that Upstream is untouched and RHBQ gets what is capable to render?

      ```

      1. footnote:x[] -> footnoteref:[x]
        for i in `find . -name "*.adoc"`; do sed 's/footnote:([a-zA-Z]+)[]/footnoteref:[\1]/g' -i $i; done
      2. footnote:x[y] -> footnoteref:[x,y]
        for i in `find . -name ".adoc"`; do sed 's/footnote:([a-zA-Z]+)[(.)]/footnoteref:[\1, \2]/g' -i $i; done
        ```

      This patch is suitable for 3.2 and 3.8 because of their RHBQ Release Notes.

      Thank you!

              Unassigned Unassigned
              olubyans@redhat.com Alexey Loubyansky
              Jakub Jedlicka Jakub Jedlicka
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: