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 f78532b5cc collapsibles, heading alignments closes #2076
new a3f625bb9c Merge pull request #2101 from bamaer/2076
f78532b5cc is described below
commit f78532b5cc02132c48621c5191cee02177b557df
Author: Bart Maertens <[email protected]>
AuthorDate: Thu Dec 22 15:39:06 2022 +0100
collapsibles, heading alignments closes #2076
---
docs/hop-user-manual/modules/ROOT/nav.adoc | 3 ++-
.../modules/ROOT/pages/getting-started/index.adoc | 2 +-
.../modules/ROOT/pages/hop-gui/file-dialog.adoc | 2 +-
.../modules/ROOT/pages/hop-gui/index.adoc | 2 +-
.../modules/ROOT/pages/hop-gui/perspectives.adoc | 3 ++-
.../modules/ROOT/pages/hop-run/index.adoc | 10 +++++++
.../modules/ROOT/pages/hop-server/index.adoc | 10 +++++++
.../hop-tools/hop-conf/hop-conf-projects.adoc | 4 +++
.../ROOT/pages/hop-tools/hop-conf/hop-conf.adoc | 9 +++++++
.../modules/ROOT/pages/hop-tools/hop-gui.adoc | 25 +++++++++++++++++
.../modules/ROOT/pages/hop-tools/hop-import.adoc | 10 +++++++
.../modules/ROOT/pages/hop-tools/hop-search.adoc | 10 +++++++
.../ROOT/pages/hop-tools/hop-translator.adoc | 2 +-
.../modules/ROOT/pages/hop-tools/index.adoc | 4 +--
.../ROOT/pages/how-to-guides/joins-lookups.adoc | 2 +-
.../modules/ROOT/pages/metadata-types/index.adoc | 2 +-
.../pipeline/beam/beam-samples-direct-runner.adoc | 2 +-
.../modules/ROOT/pages/pipeline/errorhandling.adoc | 2 +-
.../ROOT/pages/pipeline/hop-pipeline-editor.adoc | 2 +-
.../modules/ROOT/pages/plugins/plugins.adoc | 2 +-
.../modules/ROOT/pages/projects/advanced.adoc | 31 ++++++++++++++++++++++
.../modules/ROOT/pages/projects/metadata.adoc | 2 +-
.../modules/ROOT/pages/samples/samples.adoc | 2 +-
.../modules/ROOT/pages/technology/technology.adoc | 2 +-
.../modules/ROOT/pages/workflow/actions.adoc | 2 +-
.../modules/ROOT/pages/workflow/workflows.adoc | 8 +++---
26 files changed, 133 insertions(+), 22 deletions(-)
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc
b/docs/hop-user-manual/modules/ROOT/nav.adoc
index 920a4e8ca6..710255f084 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -249,6 +249,7 @@ under the License.
*** xref:pipeline/transforms/userdefinedjavaclass.adoc[User Defined Java Class]
*** xref:pipeline/transforms/userdefinedjavaexpression.adoc[User Defined Java
Expression]
*** xref:pipeline/transforms/valuemapper.adoc[Value Mapper]
+*** xref:pipeline/transforms/verticabulkloader.adoc[Vertica Bulk Loader]
*** xref:pipeline/transforms/webservices.adoc[Web services lookup]
*** xref:pipeline/transforms/workflowexecutor.adoc[Workflow Executor]
*** xref:pipeline/transforms/writetolog.adoc[Write to log]
@@ -437,7 +438,7 @@ under the License.
* xref:hop-tools/index.adoc[Hop Tools]
** xref:hop-tools/hop-conf/hop-conf.adoc[hop-conf]
** xref:hop-tools/hop-encrypt.adoc[hop-encrypt]
-** xref:hop-gui/index.adoc[hop-gui]
+** xref:hop-tools/hop-gui.adoc[hop-gui]
** xref:hop-run/index.adoc[hop-run]
** xref:hop-tools/hop-search.adoc[hop-search]
** xref:hop-tools/hop-import.adoc[hop-import]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/getting-started/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/index.adoc
index d0c41d40c7..99e594e56e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/getting-started/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/getting-started/index.adoc
@@ -20,7 +20,7 @@ under the License.
:page-pagination-no-back:
:description: The Apache Hop Getting Started guide walks new Hop users through
the Hop concepts and the bare necessities to get started building workflows and
pipelines.
-= Getting Started
+== Getting Started
This guide walks you through the Hop basics.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
index 6b6b611eea..41e5e8a374 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
@@ -17,7 +17,7 @@ under the License.
:imagesdir: ../assets/images
:description: Hop Gui's file dialog is a powerful tool that not only lets you
browse for files and folders, but also shows a lot of metadata about files,
allows you to create bookmarks etc.
-= Hop File Dialog
+== Hop File Dialog
The Hop File Dialog is a versatile tool you'll use often while working in Hop
Gui.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
index 77ef053d3e..a4b7ba3856 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
@@ -19,7 +19,7 @@ under the License.
:description: Hop Gui is Hop's visual development environment where you will
mainly design, run and debug workflows and pipelines, but Hop Gui has a lot
more to offer: you can configure all of your metadata items like database
connections, run configurations etc. You can search, manage files, version
control your work and more.
-= Hop Gui
+== Hop Gui
Hop Gui is Hop's visual development environment. You'll spend a lot of time
here in the various perspectives of Hop GUI.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
index cf1b4a62b1..4178ad3503 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
@@ -14,7 +14,8 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-= Hop Gui Perspectives
+
+== Hop Gui Perspectives
:imagesdir: ../assets/images
:description: Hop Gui provides a number of perspectives for a variety of
tasks. You'll spend most of your time in the data orchestration perspective,
building workflows and pipelines, but other perspectives for metadata
management, file management, search etc offer tons of functionality.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-run/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-run/index.adoc
index fddd2d3906..bb0edc9241 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-run/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-run/index.adoc
@@ -34,6 +34,12 @@ On Windows, run `hop-run.bat`. The command on Mac and Linux
is `hop-run.sh`.
You'll see the option listed in a similar output to the one below:
+ +
+
+.Usage
+[%collapsible]
+=====
+
.Output of help
[source,bash]
----
@@ -109,6 +115,10 @@ Check the
xref:pipeline/pipeline-run-configurations/pipeline-run-configurations.
|A comma separated list of KEY=VALUE pairs
|===
+=====
+
+ +
+
== Examples
The example below runs the `switch-case-basic.hpl` pipeline from the samples
project through `hop-run`. +
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-server/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/index.adoc
index 8749d1c8e1..d2735abac2 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-server/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-server/index.adoc
@@ -33,6 +33,12 @@ Hop Server is available as a script in your Hop installation
directory.
Run Hop Server without any parameters to display its usage options.
On Windows, this is `hop-server.bat`, on Mac and Linux, run `hop-server.sh`.
+ +
+
+.Usage
+[%collapsible]
+=====
+
[source,bash]
----
Usage: <main class> [-k] [-gs] [-e=<environmentOption>] [-id=<id>]
@@ -127,6 +133,10 @@ This is provided for by the 'projects' plugin.
|===
+=====
+
+ +
+
=== Start Hop Server with command line parameters
Hop Server can be started with hostname or ip address and port number as
unnamed arguments:
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf-projects.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf-projects.adoc
index 9f20c301b6..80078dda95 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf-projects.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf-projects.adoc
@@ -105,6 +105,8 @@ As you can see from the log, an empty file was created to
set variables in:
This command adds a variable to the environment configuration file:
+ +
+
[tabs]
====
Windows::
@@ -176,6 +178,8 @@ Please run hop-conf without options to see all the
possibilities.
The following example deletes an environment from the Hop configuration file:
+ +
+
[tabs]
====
Windows::
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
index 0573cb1911..5d66627c35 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-conf/hop-conf.adoc
@@ -25,6 +25,11 @@ under the License.
Hop Conf is a command line tool to manage environments.
The *hop-conf.sh* script can be run with the *-h* flag (`./hop-conf.sh -h`) to
display available options.
+ +
+
+.Usage
+[%collapsible]
+=====
[source,bash]
----
Usage: <main class> [-h] [-ec] [-ed] [-el] [-em] [-ey] [-pc] [-pd] [-pl] [-pm]
@@ -212,6 +217,10 @@ TIP: `-sv` can be used to unset a variable by specifying a
variable without a va
|-pv|--project-variables=<projectVariables>[,<projectVariables>...]| A list of
variable=value combinations separated by a comma
|===
+=====
+
+ +
+
=== project variables Examples
This is a list of examples on how the parameters on this command are parsed
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-gui.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-gui.adoc
new file mode 100644
index 0000000000..66fd38f6c3
--- /dev/null
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-gui.adoc
@@ -0,0 +1,25 @@
+////
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+ http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+////
+:description: Hop Encrypt is a command line tool to encrypt (obfuscate)
passwords for use in XML, password or Hop metadata files.Hop Gui is Hop’s
visual development environment. You’ll spend a lot of time here in the various
perspectives of Hop GUI.
+
+== Hop GUI
+
+Hop GUI is the visual integrated development environment (IDE) for Apache Hop.
+
+== Usage
+
+Hop GUI doesn't take any parameters or arguments. To start, just run
`hop-gui.bat` on Window or `hop-run.sh` on Linux and Mac OS.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-import.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-import.adoc
index b19a123f69..c44e7fd828 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-import.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-import.adoc
@@ -28,6 +28,12 @@ See also these plugins:
Usage help can be obtained by running hop-import with the `-h` option, even
when other options are specified:
+ +
+
+.Usage
+[%collapsible]
+=====
+
[source]
----
Usage: <main class> [-efhlp] [-c=<targetConfigFilename>] [-i=<inputFolderName>]
@@ -54,6 +60,10 @@ Usage: <main class> [-efhlp] [-c=<targetConfigFilename>]
[-i=<inputFolderName>]
-t, --type=<type> The type of import plugin to use (e.g. kettle)
----
+=====
+
+ +
+
== Examples
Import a set of Kettle files and folders into a project stored on Amazon AWS
S3:
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
index 0df92ec625..2557222f5d 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
@@ -20,6 +20,12 @@ under the License.
Hop Search is a command line tool to search for metadata in Hop or a Hop
project.
+ +
+
+.Usage
+[%collapsible]
+=====
+
== Usage
[source,bash]
@@ -52,6 +58,10 @@ Usage: <main class> [-hilx] [-e=<environmentOption>]
[-j=<projectOption>]
|-x|The specified search string is a regular expression
|===
+=====
+
+ +
+
== Examples
Example command: search for the string 'json' (case insensitive) in the
'hop-samples' project.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-translator.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-translator.adoc
index d094aad978..a155778d84 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-translator.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-translator.adoc
@@ -15,7 +15,7 @@ specific language governing permissions and limitations
under the License.
////
-= Hop Translator - Translate the Apache Hop GUI and CLI tools
+== Hop Translator - Translate the Apache Hop GUI and CLI tools
include::../snippets/hop-tools/hop-translator.adoc[]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/index.adoc
index 343685afc3..cf82caf261 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/index.adoc
@@ -15,7 +15,7 @@ specific language governing permissions and limitations
under the License.
////
:description: Even though Hop developers will spend the majority of their time
in Hop Gui, Hop has a lot more tools to offer. This page provides an overview
of the tools that are available in the platform.
-= Hop Tools
+== Hop Tools
Even though Hop developers will spend the majority of their time in Hop Gui,
Hop has a lot more tools to offer.
@@ -23,7 +23,7 @@ This page provides an overview of the tools that are
available in the platform.
* xref:hop-tools/hop-conf/hop-conf.adoc[Hop Conf]
* xref:hop-tools/hop-encrypt.adoc[Hop Encrypt]
-* xref:hop-gui/index.adoc[Hop Gui]
+* xref:hop-tools/hop-gui.adoc[Hop Gui]
* xref:hop-run/index.adoc[Hop Run]
* xref:hop-tools/hop-search.adoc[Hop Search]
* xref:hop-tools/hop-import.adoc[Hop Import]
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/joins-lookups.adoc
b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/joins-lookups.adoc
index 9108a1d293..b11eb0c18c 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/joins-lookups.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/joins-lookups.adoc
@@ -18,7 +18,7 @@ under the License.
:imagesdir: ../../assets/images
:description: This guide provides an overview of the various join and lookup
transforms and helps you to choose which transform makes most sense for your
use case.
-= Joins and lookups
+== Joins and lookups
Hop offers a lot of options to enrich and combine data, among other things
through joins and lookups. This guide explains the differences between the
various joins and lookups, and will help you to choose the right transform for
your pipelines.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/index.adoc
index dc222e9d85..4da9ef9fba 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/index.adoc
@@ -18,7 +18,7 @@ under the License.
:page-pagination-no-back:
:description: Metadata is one of the cornerstones in Hop and can be defined as
workflows, pipelines and any other type of metadata objects. Hop Gui has a
Metadata Perspective to manage all types of metadata: run configurations,
database (relational and NoSQL) connections, logging, and pipeline probes just
to name a few.
-= Metadata Types
+== Metadata Types
Metadata is one of the cornerstones in Hop and can be defined as workflows,
pipelines and any other type of metadata objects.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/beam/beam-samples-direct-runner.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/beam/beam-samples-direct-runner.adoc
index 3e67c0aaa9..32638f61b2 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/beam/beam-samples-direct-runner.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/beam/beam-samples-direct-runner.adoc
@@ -20,7 +20,7 @@ under the License.
:toc:
-= Running the Apache Beam samples With the Beam Direct Runner
+== Running the Apache Beam samples With the Beam Direct Runner
The Direct Runner executes pipelines on your machine and is designed to
validate that pipelines adhere to the Apache Beam model as closely as possible.
Instead of focusing on efficient pipeline execution, the Direct Runner performs
additional checks to ensure that users do not rely on semantics that are not
guaranteed by the model.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/errorhandling.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/errorhandling.adoc
index dda46390a6..7ae9a66c80 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/errorhandling.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/errorhandling.adoc
@@ -18,7 +18,7 @@ under the License.
:imagesdir: ../assets/images
:description: When a major failure occurs in one of the transforms, the
pipeline is notified and halts all active operations. This is fine in most
cases, pipeline failures are typically handled in the parent workflow. In some
cases however, there are errors you'll want to handle gracefully without
halting the entire pipeline.
-= Pipeline Error Handling
+== Pipeline Error Handling
When a major failure occurs in one of the transforms, the pipeline is notified
and halts all active operations. This is fine in most cases, pipeline failures
are typically handled in the parent workflow (check the
xref:/workflow/create-workflow.adoc[create workflow] page to learn about error
hops in workflows).
In some cases however, there are errors you'll want to handle gracefully
without halting the entire pipeline.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/hop-pipeline-editor.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/hop-pipeline-editor.adoc
index 63070b8474..9a1c626fe2 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/pipeline/hop-pipeline-editor.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/pipeline/hop-pipeline-editor.adoc
@@ -18,7 +18,7 @@ under the License.
:imagesdir: ../assets/images
:description: You'll perform a lot of operations on the pipeline canvas, but a
lot of additional functionality is available from the pipeline editor's main
toolbar
-= Toolbar
+== Toolbar
You learned to create a pipeline in xref:pipeline/create-pipeline.adoc[Create
a Pipeline]. You'll perform a lot of operations on the pipeline canvas, but a
lot of additional functionality is available from the pipeline editor's main
toolbar.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/plugins/plugins.adoc
b/docs/hop-user-manual/modules/ROOT/pages/plugins/plugins.adoc
index f00dbea26d..9bfbe35fe1 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/plugins/plugins.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/plugins/plugins.adoc
@@ -17,7 +17,7 @@ under the License.
:description: Hop is built around an eco-system of plugins, this gives the end
users and infrastructure team the ability to create a custom version of HOP
tailored to the project or company needs.
[[Plugins]]
-= Plugins
+== Plugins
Hop is built around an eco-system of plugins, this gives the end users and
infrastructure team the ability to create a custom version of HOP tailored to
the project or company needs.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/projects/advanced.adoc
b/docs/hop-user-manual/modules/ROOT/pages/projects/advanced.adoc
index 5313c6f646..d620791e12 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/advanced.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/advanced.adoc
@@ -34,6 +34,12 @@ Projects and environments as such are defined in the central
Hop configuration f
By default this file lives in the `config/` folder of your Hop client
distribution.
You can change that folder by setting the `HOP_CONFIG_FOLDER` environment
variable on your system.
+ +
+
+.projectsConfig
+[%collapsible]
+=====
+
In `hop-config.json`, you'll find a `"projectsConfig"` section.
By default it contains the following:
@@ -65,9 +71,20 @@ By default it contains the following:
As you can see the standard Hop client distribution defines 2 projects:
default and samples.
+=====
+
+ +
+
=== Project Configuration
Every project has extra metadata and settings stored in a project
configuration file called ```project-config.json```. For the samples project
this would be ```config/projects/samples/project-config.json```.
+
+ +
+
+.project-config.json
+[%collapsible]
+=====
+
Let's take a look at it:
[source,json]
@@ -84,6 +101,10 @@ Let's take a look at it:
}
----
+=====
+
+ +
+
==== Variables
You can define variables on a project level as well.
@@ -99,6 +120,12 @@ Hop enviroments and their home folders are stored in the
hop configuration file
That file lives by default in the *config* folder of the Hop installation.
System property `HOP_CONFIG_FOLDER` can also be used to point to a different
folder
+ +
+
+.environmentConfig
+[%collapsible]
+=====
+
[source,json]
{
"environmentConfig" : {
@@ -115,6 +142,10 @@ System property `HOP_CONFIG_FOLDER` can also be used to
point to a different fol
}
}
+=====
+
+&nbps; +
+
== Command Line Project Configuration
In addition to the Hop Gui and configuration files, all aspects of and
operations on projects and environments can be managed through the Hop Conf
command line tool.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
b/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
index b6fc1c4a2d..941902d916 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/metadata.adoc
@@ -22,7 +22,7 @@ under the License.
:description: A project's metadata typically contains a number of database
connections (relational or NoSQL), logging configurations and so on. This
metadata is stored on a project level and is available through the metadata
perspective.
-= Project Metadata
+== Project Metadata
A project's metadata typically contains a number of database connections
(relational or NoSQL), logging configurations and so on.
This metadata is stored on a project level and is available through the
metadata perspective.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/samples/samples.adoc
b/docs/hop-user-manual/modules/ROOT/pages/samples/samples.adoc
index 53caf683bd..5705a0072e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/samples/samples.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/samples/samples.adoc
@@ -16,7 +16,7 @@ under the License.
////
:description: Hop comes with a set of samples for workflows, pipelines,
actions, transforms and other metadata objects. These samples are included in
your default Hop installation as the Samples project.
[[Samples]]
-= Samples
+== Samples
Hop comes with a set of samples for workflows, pipelines, actions, transforms
and other metadata objects.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
b/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
index 6ada1917c2..f1c0e760e2 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
@@ -17,7 +17,7 @@ under the License.
////
:description: Hop integrates with tens if not hundreds of different
technologies. The Azure, Apache Cassandra, Google and Neo4j platforms are
supported at various points in Hop and are covered in their own section.
-= Technology
+== Technology
This section contains technology-stack specific information.
The goal is to inform you about how Apache Hop offers support for the
technology in question.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions.adoc
index 911f4f0be4..6aa4bfe2da 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions.adoc
@@ -17,7 +17,7 @@ under the License.
:description: Actions are used the objects that are executed in a workflow.
They are logical operators that do not manipulate your data but create actions
that have to be performed around your pipelines.
[[actions-plugins]]
-= Action Plugins
+== Action Plugins
Actions are used the objects that are executed in a workflow. They are logical
operators that do not manipulate your data but create actions that have to be
performed around your pipelines.
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/workflows.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/workflows.adoc
index 9319dec3bc..1296df86f3 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/workflows.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/workflows.adoc
@@ -18,9 +18,9 @@ under the License.
:imagesdir: ../assets/images
:description: Workflows are one of the core building blocks in Apache Hop.
Where pipelines do the heavy data lifting, workflows take care of the
orchestration work: prepare the environment, fetch remote files, perform error
handling and executing child workflows and pipelines.
-= Workflows
+== Workflows
-== Workflow overview
+=== Workflow overview
Workflows are one of the core building blocks in Apache Hop. Where pipelines
do the heavy data lifting, workflows take care of the orchestration work:
prepare the environment, fetch remote files, perform error handling and
executing child workflows and pipelines.
@@ -35,7 +35,7 @@ Even though there is some visual resemblance, workflows and
pipelines operate ve
* Workflow actions do not pass data over hops. Each workflow action has a
`success` or `failure` exit status. This exit status is used to choose the
routing through the workflow.
* Hops between actions in a workflow have a status: depending on the exit
status of the previous action, a workflow hop can follow the success (green),
failure (orange) or unconditional (black) hop. An unconditional hop ignores the
exit status of the previous action and is followed whether the previous action
failed or succeeded.
-== Example workflow walk-through
+=== Example workflow walk-through
Like all workflows, the example workflow shown below starts with the `start`
action.
@@ -51,7 +51,7 @@ If the temporary files are removed successfully, we move on
to the "success" act
image:hop-gui/workflow/basic-workflow.png[Workflows - basic workflows,
width="65%"]
-== Next steps
+=== Next steps
The following pages take you deeper into the process of building and running
workflows:
