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

Rearchitect {url-quarkusio-guides} attributes in downstream repo to align with upstream

XMLWordPrintable

    • 3
    • False
    • Hide

      None

      Show
      None
    • False

      ssitani & 142934-CCS-smanocha 

      Today we have an attribute in common called:

      {{

      {url-quarkusio-guides}

      }}

      In the RH build of Quarkus downstream docs, when we link to the upstream Quarkus docs we use a variable that's set to the release version value that the docs need to map to. For example:

      For instructions on how to install the Quarkus CLI, refer to the community-specific information at link:{url-quarkusio-guides}cli-tooling[Quarkus CLI].

      Where:
      :url-quarkusio-guides: https://quarkus.io/version/{ProductVersion}/guides/
      :ProductVersion: 3.2

      This generates the URL: https://quarkus.io/version/3.2/guides/cli-tooling

      CHANGES NEEDED FOR UPSTREAM HARMONY:

      1. Until the 3.2 doc tree is published by Guillaume, we cannot use the {ProductVersion}attribute in our {url-quarkusio-guides} value.
      2. The upstream source also has an attribute called {quarkusio-guides} for the same purpose.
      3. We must remove the trailing / from our attribute URL value as the upstream doc build adds a URL to processed links.

      See related upstream PR with the request from the upstream community: https://github.com/quarkusio/quarkus/pull/35148

              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: