From ee6493e250ebf2e0e555bb9f312af632f45671ad Mon Sep 17 00:00:00 2001 From: Rolfe Dlugy-Hegwer Date: Tue, 27 Jun 2023 12:00:56 -0400 Subject: [PATCH] Make necessary changes to share the topic with both community and product docs. --- docs/src/main/asciidoc/_attributes.adoc | 4 ++-- docs/src/main/asciidoc/update-quarkus.adoc | 12 +++++------- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/docs/src/main/asciidoc/_attributes.adoc b/docs/src/main/asciidoc/_attributes.adoc index 16ea1b43215d8..102641c4cdfbd 100644 --- a/docs/src/main/asciidoc/_attributes.adoc +++ b/docs/src/main/asciidoc/_attributes.adoc @@ -53,9 +53,9 @@ :vault-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/index.html :vault-datasource-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-vault/dev/vault-datasource.html :micrometer-registry-guide: https://quarkiverse.github.io/quarkiverse-docs/quarkus-micrometer-registry/dev/index.html -:quarkus-migration-guide: https://github.com/quarkusio/quarkus/wiki/Migration-Guides +:quarkus-migration-guide: https://github.com/quarkusio/quarkus/wiki/Migration-Guides[Migration Guides] // . :create-app-group-id: org.acme :create-cli-group-id: {create-app-group-id} // . -include::_attributes-local.adoc[] \ No newline at end of file +include::_attributes-local.adoc[] diff --git a/docs/src/main/asciidoc/update-quarkus.adoc b/docs/src/main/asciidoc/update-quarkus.adoc index e787c7724323a..b6f69f82fd3a4 100644 --- a/docs/src/main/asciidoc/update-quarkus.adoc +++ b/docs/src/main/asciidoc/update-quarkus.adoc @@ -10,12 +10,10 @@ include::_attributes.adoc[] :extension-status: "experimental" :summary: Learn how to upgrade your projects to the latest version of {project-name} -include::{includes}/extension-status.adoc[] - -You can update or upgrade your {project-name} projects to the latest version by using an update command. +You can update or upgrade your {project-name} projects to the latest version of {project-name} by using an update command. The update command primarily employs OpenRewrite recipes to automate updates for most project dependencies, source code, and documentation. -Although these recipes update many migration items, they do not cover all the items detailed in the {quarkus-migration-guide}[Migration Guide] topics. +Although these recipes update many migration items, they do not cover all the items detailed in the {quarkus-migration-guide}. Post-update, if expected updates are missing, consider the following reasons: @@ -38,8 +36,8 @@ include::{includes}/prerequisites.adoc[] . Create a working branch for your project by using your version control system. -. Install the *latest version* of the Quarkus CLI to use in the next step. For more information, see link:https://quarkus.io/guides/cli-tooling#installing-the-cli[Installing the CLI]. -Confirm the version number by using `quarkus -v`. +. To use the Quarkus CLI in the next step, link:https://quarkus.io/guides/cli-tooling#installing-the-cli[install the latest version of the Quarkus CLI]. +Confirm the version number using `quarkus -v`. . Go to the project directory and update the project to the latest stream: + @@ -74,7 +72,7 @@ ifdef::devtools-wrapped[+] . Use a diff tool to inspect all changes. -. Review the {quarkus-migration-guide}[Migration Guide] topics for items that were not updated by the update command. +. Review the {quarkus-migration-guide} for items that were not updated by the update command. If your project has such items, implement the additional steps advised in these topics. . Ensure the project builds without errors, all tests pass, and the application functions as required before deploying to production.