jbertram commented on code in PR #4246:
URL: https://github.com/apache/activemq-artemis/pull/4246#discussion_r1010083439


##########
docs/user-manual/en/versions.md:
##########
@@ -8,6 +8,22 @@ This chapter provides the following information for each 
release:
   - **Note:** Follow the general upgrade procedure outlined in the [Upgrading 
the Broker](upgrading.md) 
     chapter in addition to any version-specific upgrade instructions outlined 
here.
 
+
+## Upgrading tool
+
+Since version 2.27.0, it is possible to uptadate all the paths of an instance 
toward a newer version.
+
+To upgrade to a new version, simply do the following code:
+
+```shell
+cd $NEW_ARTEMIS_DOWNLOAD/bin/
+./artemis upgrade PATH_TO_UPGRADING INSTANCE
+```
+
+artemis, artemis.profile will be updated to the new version.
+
+(Notice: to avoid removing eventual user's  customizations of the scripts, we 
don't automatically bring new additions to the script. Please check your 
artemis and artemis.profile accordingly after the upgrade)

Review Comment:
   I think this documentation would make sense in `upgrading.md` as that's 
where the general upgrade instructions are. I also think it would be good to 
explain why the script should be used instead of the normal manual process of 
just changing the `ARTEMIS_HOME` location in `artemis.profile`.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to