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

Document configuring your Quarkus application guide

XMLWordPrintable

    Create configuring your Quarkus application guide by lift and shift the existing configure your Quarkus application guide with the following changes:

    Version number:

    • We use the QuarkusPluginVersion AsciiDoc attribute to substitute the release version. The value of this attribute is defined in the common/attributes.adoc file in product documentation repository. The value of this attribute has already been updated to match the current release version (that is, 2.2.3.Final-redhat-00013) in a previous update. Please ensure that you create the topic branch for your updates based on the quarkus-2-2 branch to ensure that you are working with the most recently updated version of the content.

    Name of the Quarkus Maven plugin:

    • In the modules/proc_creating-config-quickstart-project.adoc file, change the name of the Quarkus Maven Plugin in the command example in Step 2 of the procedure from io.quarkus:quarkus-maven-plugin to: com.redhat.quarkus.platform:quarkus-maven-plugin
      The updated example should look as is shown in the following example :
      mvn com.redhat.quarkus.platform:quarkus-maven-plugin:{QuarkusPluginVersion}:create \
          -DprojectGroupId=org.acme \
          -DprojectArtifactId=config-quickstart \
          -DplatformGroupId=com.redhat.quarkus \
          -DplatformVersion={QuarkusPluginVersion} \
          -DclassName="org.acme.config.GreetingResource" \
          -Dpath="/greeting"
      cd config-quickstart
      

    Additional resources

    • remove the link to Testing your Quarkus applications form the additional resources section.
      Please remove the link completely (as opposed to commenting it out), because our publishing tool does not allow having AsciiDoc comments in the additional resources section.

      1.
      Document Chapter 1, 2, and 3 for this lift and shift task Sub-task Closed Major Sheila Jones
      2.
      Document Chapter 4 and 5 for this lift and shift task Sub-task Closed Major Michelle Purcell
      3.
      Document Chapter 6, 7, and 8 for this lift and shift task Sub-task Closed Major Sheila Jones
      4.
      Document Chapter 9 and 10 for this lift and shift task Sub-task Closed Major Michelle Purcell
      5.
      Document Chapter 11, 12, 13, and 14 for this lift and shift task Sub-task Closed Major Sheila Jones
      6.
      Introduction should mention application.yaml Sub-task Closed Major Michelle Purcell
      7.
      Mention OpenShift Config Map in Section 1 Sub-task Closed Major Michelle Purcell
      8.
      Avoid listing docker files Sub-task Closed Major Michelle Purcell
      9.
      Do we have a Red Hat version of the Quickstarts Sub-task Closed Major Michelle Purcell
      10.
      Weird section ordering Sub-task Closed Major Michelle Purcell
      11.
      Section 4 should mention the usage of the properties format Sub-task Closed Major Michelle Purcell
      12.
      Is it ok to have non-compiling snippets? Sub-task Closed Major Michelle Purcell
      13.
      Wrong error in 4 point 3 Sub-task Closed Major Michelle Purcell
      14.
      Should command+C be mentioned when mentioning CTRL+C Sub-task Closed Major Michelle Purcell
      15.
      ./mvnw quarkus:devreturn Sub-task Closed Major Michelle Purcell
      16.
      4.1 should mentioned that it's not in the MP spec Sub-task Closed Major Michelle Purcell
      17.
      Unused import in 4.1 Snippet 1 Sub-task Closed Major Michelle Purcell
      18.
      CTRL+C in bold in section 4 point 7 Sub-task Closed Major Michelle Purcell
      19.
      Rename section 5 Sub-task Closed Major Michelle Purcell
      20.
      Section 6 should be a before Sub-task Closed Major Michelle Purcell
      21.
      Useless clean in the snippet 6.1 Sub-task Closed Major Michelle Purcell
      22.
      YAML configuration section should be moved Sub-task Closed Major Michelle Purcell
      23.
      Why is the section 13 in this documentation Sub-task Closed Major Michelle Purcell

          mpurcell@redhat.com Michelle Purcell
          142934-CCS-smanocha Sunayna Manocha
          Josef Smrcka Josef Smrcka (Inactive)
          Stefan Sitani, Thomas Qvarnström
          Votes:
          0 Vote for this issue
          Watchers:
          10 Start watching this issue

            Created:
            Updated:
            Resolved: