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

Improve the Migration guide ([ContentX]: Goal 2.1 Scope and plan content improvements)

XMLWordPrintable

    • Icon: Epic Epic
    • Resolution: Done
    • Icon: Normal Normal
    • None
    • None
    • ContentX
    • None
    • Improve the Migration guide ([ContentX]: Goal 2.1 Scope and plan content improvements)
    • 1
    • False
    • Hide

      None

      Show
      None
    • False
    • To Do
    • 0% To Do, 0% In Progress, 100% Done
    • Quarkus Docs Sprint 29, Quarkus Docs Sprint 30

      Recommendations

      • Revise the Wording and Structure: Conduct a thorough review of the Migration Guide to simplify and clarify the language and structure. Reorganize the content to present user options and step-by-step procedures in a more straightforward and logical order. This will help users understand their choices and effectively follow the migration process.
      • Specify the Relevant Migration Guides: Identify the specific community migration guides users should refer to for additional information. Update the guide by providing direct links to these relevant resources. This will eliminate confusion and ensure users are directed to the correct documentation for their needs.
      • Detail the quarkus update Command Behavior: Add information to the community migration guides that details which updates are automatically handled by the quarkus update command and which require manual intervention. This will provide users with the crucial information they need to successfully complete the migration process without missing any necessary steps.

              rdlugyhe Rolfe Dlugy-Hegwer
              rdlugyhe Rolfe Dlugy-Hegwer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: