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

Fix attributes and includes in security adoc files downported to downstream repo

XMLWordPrintable

    • Quarkus Upstream Docs Sprint 4, Quarkus Upstream Docs Sprint 5

      Fix this problem:

      Raw upstream AsciiDoc source files imported into the downstream will contain invalid Attributes and Include statements. Attributes will render as, for example "

      {maven-version}

      " and include statements as, for example, "Invalid include: {includes}/devtools/create-app.adoc"

      Why? 

      Because the target Attributes file and Includes files does not exist locally. 

      Scope of this PR

      1. Review the imported security files and determine the attribute values that need to be resolved. 
      2. Figure out which attributes are:
        1. built-in asciidoc ones (like {imagesdir} )
        2. essential for upstream-first docs.
        3. identical or duplicate what we already have in downstream.
      3. Downport the required attributes files to the downstream gitlab repo (attributes.adoc and attributes-local.adoc).
      4. Review the upstream attributes files and update the relevant values that apply to the security content being downported downstream (note, not all upstream attributes will be relevant.
      5. Re-architect the attribute implementation if needed so that 2 goals are achieved:
        1. Minimal or zero changes are needed in the imported upstream-first adoc source file. They work automatically.
        2. They align with the downstream source docs attribute approach too where possible.
        3. They work on PV2.
      6. Test solution on PV2 and ensure all attributes render correctly.

      Useful links:

      Research done: MR 902

      List of invalid links/includes on PV2: Spot check of content imported to PV2 sandbox Google doc

       

        1. image-2023-02-20-11-21-41-280.png
          30 kB
          Michelle Purcell
        2. image-2023-03-02-11-32-48-537.png
          48 kB
          Michelle Purcell
        3. image-2023-03-03-15-27-32-392.png
          23 kB
          Michelle Purcell

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

                Created:
                Updated:
                Resolved: