Uploaded image for project: 'WildFly'
  1. WildFly
  2. WFLY-18925

Flattened Quickstart READMEs

XMLWordPrintable

    • Icon: Enhancement Enhancement
    • Resolution: Done
    • Icon: Major Major
    • 31.0.0.Final
    • None
    • Quickstarts
    • None

      The QS READMEs don't render correctly on GitHub due to the lack of GH support for the include Asciidoc directive. We should try to workaround that and one approach would be:

      1. Rename all README.adoc to README-source.adoc
      2. Use asciidoctor-reduce to generate flat README.adoc from each README-source.adoc. This could be done on a GH job to auto flat on any *.adoc change (maybe inspired on https://github.com/asciidoctor/asciidoctor-reducer?tab=readme-ov-file#reduce-files-in-a-github-repository )

            amehenda@redhat.com Ashwin Mehendale
            emartins@redhat.com Eduardo Martins
            Votes:
            1 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              Resolved: