[incubator-hop] branch master updated: HOP-3316 corrected environment instead of project references, various minor updates and additions

[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/incubator-hop.git


The following commit(s) were added to refs/heads/master by this push:
     new b937442  HOP-3316 corrected environment instead of project references, various minor updates and additions
     new 445a18c  Merge pull request #1201 from bamaer/HOP-3316
b937442 is described below

commit b9374428daadef8233bbb1913f90e14f6b55bd6c
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Sat Nov 27 10:47:19 2021 +0100

    HOP-3316 corrected environment instead of project references, various minor updates and additions
---
 .../hop-gui/environment/create-project-dialog.png  | Bin 0 -> 115029 bytes
 .../environment/create-project-dialogue.png        | Bin 427481 -> 0 bytes
 .../hop-gui/environment/environment-variables.png  | Bin 0 -> 106873 bytes
 .../modules/ROOT/pages/projects/index.adoc         |   6 ++++++
 .../ROOT/pages/projects/projects-environments.adoc |  22 ++++++++++++++-------
 5 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialog.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialog.png
new file mode 100644
index 0000000..5ec612c
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialog.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialogue.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialogue.png
deleted file mode 100644
index dc87754..0000000
Binary files a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/create-project-dialogue.png and /dev/null differ
diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/environment-variables.png b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/environment-variables.png
new file mode 100644
index 0000000..6dfb097
Binary files /dev/null and b/docs/hop-user-manual/modules/ROOT/assets/images/hop-gui/environment/environment-variables.png differ
diff --git a/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc b/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc
index 990b7f6..56d55c9 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc
@@ -42,7 +42,13 @@ Hop wants to make it easy for Hop developers to use one or more projects alongsi
 A project is the collection of all the files you need in your data orchestration solution.
 This typically includes metadata, pipelines, workflows, reference files, documentation and so on.
 To match standard development best practices you would check all these files into a version control system like git.
+
+TIP: project variables should only be used when you need variables on the project level. All variables to connect to infrastructure, e.g. database connection parameters, mail servers etc that take different values in different environments should be created at the environment level.
+
+TIP: Project configurations are stored in hop-config.json, which is read from `hop/config` by default. Use the `${HOP_CONFIG_FOLDER}` operating system variable to store your Hop configuration in a folder outside your Hop folder. This will let you keep your project list if you switch Hop installations or upgrade to a newer Hop version.
+
 Projects can inherit metadata and variables from a parent project.
+
 Projects in Hop Gui will remember opened files, zoom levels and other UI settings.
 
 === Environments
diff --git a/docs/hop-user-manual/modules/ROOT/pages/projects/projects-environments.adoc b/docs/hop-user-manual/modules/ROOT/pages/projects/projects-environments.adoc
index 9325a55..4e808f3 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/projects-environments.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/projects-environments.adoc
@@ -31,9 +31,9 @@ To create a new project click the *Add a new project* button.
 image:hop-gui/environment/project-add.svg[Add a new project]
 
 
-This button opens the following dialogue:
+This button opens the following dialog:
 
-image:hop-gui/environment/create-project-dialogue.png[Create a project,width="60%"]
+image:hop-gui/environment/create-project-dialog.png[Create a project,width="90%"]
 
 .Project Properties
 [id="tab-proj-props",cols="20%,45%,5%,5%,25%",options="header"]
@@ -42,13 +42,14 @@ image:hop-gui/environment/create-project-dialogue.png[Create a project,width="60
 |Name|The project name|Yes|No|
 |Home folder|The folder where the project is located|Yes|No|
 |Configuration file (relative path)|The folder where the project's configuration json is located.|Yes|Yes|
+|Parent project to inherit from|The project to inherit metadata (e.g. connections) from|Yes|No|default
 |Description|A description for this environment|No|No|
 |Company|The company this environment belongs to|No|No|
 |Department|The department this environment is created for|No|No|
-|Metadata base folder|The folder where this environment's metadata will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}/metadata
-|Unit test base path|The folder where this environment's unit tests will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}
-|Data Sets CSV Folder|The folder where this environment's data files will be stored|Yes|Yes|{openvar}ENVIRONMENT_HOME{closevar}/datasets
-|Enforce execution in environment home|Give an error when trying to execute a pipeline or workflow which is not located in the environment home directory or in a sub-directory|Yes|Yes|checked
+|Metadata base folder|The folder where this environment's metadata will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}/metadata
+|Unit test base path|The folder where this environment's unit tests will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}
+|Data Sets CSV Folder|The folder where this environment's data files will be stored|Yes|Yes|{openvar}PROJECT_HOME{closevar}/datasets
+|Enforce execution in project home|Give an error when trying to execute a pipeline or workflow which is not located in the environment home directory or in a sub-directory|Yes|Yes|checked
 |Project variables to set|A list of variable names, values and variable descriptions to use with this project|No|Yes|
 |===
 
@@ -69,7 +70,7 @@ image:hop-gui/environment/create-environment-dialogue.png[Create an environment,
 |===
 |Property|Description|Variables Supported|Mandatory|Default
 |Name|The environment name|No|No|The last created project
-|Purpose a|The purpose of this environment
+|Purpose a|The purpose of this environment. A purpose is an indication of the environment type. You can add your own purposes in addition to the predefined ones:
 
 * Development
 * Testing
@@ -82,8 +83,15 @@ image:hop-gui/environment/create-environment-dialogue.png[Create an environment,
 |Configuration files|Files to use as configuration for this environment|No|No|
 |===
 
+Each environment will contain one or more environment files where you manage environment-specific variables.
+
+The edit button opens the environment file and lets you add variable key-value pairs.
+
+image::hop-gui/environment/environment-variables.png[Environment Variables, width="80%"]
+
 After creating an environment the user interface will switch to it.
 
+
 == Switch between projects and environments
 
 To switch between projects the projects list can be used from the main Hop Gui toolbar.