[hop] branch master updated: HOP-3999 added Hop upgrade instructions

[ha...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

hansva pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/hop.git


The following commit(s) were added to refs/heads/master by this push:
     new 38ff146e8e HOP-3999 added Hop upgrade instructions
     new 4cce24caf8 Merge pull request #1534 from bamaer/HOP-3999
38ff146e8e is described below

commit 38ff146e8e1bd18d1b5d833e2ec442ec0ce5884d
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Thu Jun 16 20:09:11 2022 +0200

    HOP-3999 added Hop upgrade instructions
---
 .../modules/ROOT/pages/installation-configuration.adoc  | 17 +++++++++++++++--
 .../pages/snippets/variables/hop-config-folder.adoc     |  2 ++
 2 files changed, 17 insertions(+), 2 deletions(-)

diff --git a/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc b/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
index 1a94ff0b3d..115ea91abb 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
@@ -68,7 +68,7 @@ OpenJDK 64-Bit Server VM 18.9 (build 11.0.2+9, mixed mode)
 
 Make sure to point the `JAVA_HOME` environment variable for your operating system to your desired JRE installation. Refer to your operating system's documentation for more information on environment variables.
 
-== Basic Installation
+== Basic Installation [[basic]]
 
 The basic installation for Apache Hop couldn't be easier:
 
@@ -80,6 +80,18 @@ The basic installation for Apache Hop couldn't be easier:
 ** `hop-run.bat` (Windows) or `hop-run.sh` (Linux, MacOS): xref:/hop-run/index.adoc[run workflows or pipelines] from the command line.
 ** `hop-server.bat` (Windows) or `hop-server.sh` (Linux, MacOS): start a xref:/hop-server/index.adoc[Hop Server] instance.
 
+== Upgrade
+
+Multiple Hop versions can be installed side by side with the same process as described in the <<basic, Basic Installation>>.
+
+Hop installations are self-contained by default, which means you'll start with the default configuration and project and environment list with after new Hop install.
+
+This can be changed by setting the `HOP_CONFIG_FOLDER` system variable in your operating system to a folder outside any of your Hop installations.
+
+In the default self-contained configuration, Hop keeps your preferences, projects and environment in the `hop/conf` folder. If you have a configuration you'd like to keep in one of your Hop installations, copy the contents of that `hop/conf` folder to the folder your `HOP_CONFIG_FOLDER` points to.
+
+Check the <<envvars, Environment Variables>> section for more system variables that can make your life with multiple Hop versions or installations a lot easier.
+
 == Additional configuration
 
 === JVM memory settings
@@ -103,7 +115,8 @@ Check the documentation for your JRE for more information about additional JVM c
 
 TIP: **Developers**: a couple of lines below the `-Xmx` parameter, you'll find another `HOP_OPTIONS` line that contains `-Xdebug`. Uncomment this line to allow debuggers to attach to your running Hop instance. Check the xref:dev-manual::setup-dev-environment.adoc[developer documentation] for more information.
 
-=== Hop environment variables
+
+=== Hop environment variables [[envvars]]
 
 The following (operating system) environment variables can add a lot of flexibility to configure Hop to your exact needs.
 
diff --git a/docs/hop-user-manual/modules/ROOT/pages/snippets/variables/hop-config-folder.adoc b/docs/hop-user-manual/modules/ROOT/pages/snippets/variables/hop-config-folder.adoc
index e0a27c062f..34478d2852 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/snippets/variables/hop-config-folder.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/snippets/variables/hop-config-folder.adoc
@@ -17,3 +17,5 @@ under the License.
 HOP_CONFIG_FOLDER::
 Hop stores your configuration in the `config` folder by default.
 Set this environment variable to point to a folder outside of your Hop installation to keep your configuration, projects and environment list etc, no matter which Hop version or installation you use.
+
+TIP: copy the contents of an existing `hop/conf` folder to the path set in `HOP_CONFIG_FOLDER` to move the configuration from one of your Hop installations to your new central location.
\ No newline at end of file