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

Update code example in downstream OpenShift guide to match RHBQ version

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 2.13.8 GA
    • None
    • Downstream-docs
    • None

      An output example in Deploying Quarkus applications to Red Hat OpenShift Container Platform, Section 4, Verification sub-section, Step 2 in the RHBQ 2.13 documentation shows a mismatched Quarkus version: 2.16.2.Final

      in context:

      Starting the Java application using /opt/jboss/container/java/run/run-java.sh ...
      INFO exec  java -Xms125m -Xmx500m -XX:+UseParallelGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:+ExitOnOutOfMemoryError -cp "." -jar /deployments/quarkus-run.jar
      
      2023-02-10 11:58:49,077 INFO  [io.quarkus] (main) openshift-helloworld 1.0.0-SNAPSHOT on JVM (powered by Quarkus 2.16.2.Final) started in 1.399s. Listening on: http://0.0.0.0:8080
      2023-02-10 11:58:49,168 INFO  [io.quarkus] (main) Profile prod activated.
      2023-02-10 11:58:49,168 INFO  [io.quarkus] (main) Installed features: [cdi, kubernetes, resteasy-reactive, smallrye-context-propagation, vertx]
      

      Versions that we show in output examples in our product documentation should match the latest productized release version of the RHBQ stream that the documentation is intended for.
      Therefore, in RHBQ 2.13 docs, we should only be referencing Quarkus version 2.13.8.Final, as all the components in the product release are productized from 2.13.8 upstream. (Strictly speaking, the build number with the -redhat-0000X suffix only applies to "repackaged" release components, such as BOM and the productized Quarkus Maven Plugin, whereas the tested and verified extensions in the BOM retain their Final suffix upon productization.)

      This is a relatively trivial issue, since it does not create a significant risk of confusing customers (the output in question is to serve as an illustrative example rather than a prescriptive one).
      It is still an inaccuracy that we should aim to address as soon as reasonably possible.
      It is also an easy fix.

      UPDATE: the issues doe not affect the same section in 3.2.6 docs, because the version therein is up to date

              shjones@redhat.com Sheila Jones
              ssitani Stefan Sitani (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: