diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-1.png b/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-1.png index b873ea8c990..bca7902b8a2 100644 Binary files a/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-1.png and b/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-1.png differ diff --git a/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-2.png b/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-2.png index 3bcaef6eb9e..de7997ef40c 100644 Binary files a/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-2.png and b/docs/hop-user-manual/modules/ROOT/assets/images/getting-started/gs-hop-gui-overview-2.png differ diff --git a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui.adoc b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui.adoc index 0743a8750c1..ff04dc77cf8 100644 --- a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui.adoc +++ b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui.adoc @@ -27,15 +27,22 @@ The Apache Hop GUI is your local development environment to build, run, preview As we've seen in xref:getting-started/hop-tools.adoc[Hop Tools], starting Hop-Gui is easy: -On Linux or Mac: +[tabs] +==== +Windows:: ++ +-- +[source,shell] +hop-gui.bat +-- -[source,bash] +Linux, macOS:: ++ +-- +[source,shell] ./hop-gui.sh - -On Windows: - -[source,shell script] -hop-gui.bat +-- +==== == Walking through the Hop GUI @@ -45,14 +52,30 @@ image:getting-started/gs-hop-gui-overview-1.png[Hop Gui Overview] {nbsp} + -Let's divide the view into three parts: +Let's divide the view into two parts: image:getting-started/gs-hop-gui-overview-2.png[Hop Gui Overview]  -* the **menu bar** includes options mainly for managing pipelines and workflows and the Apache Hop GUI configuration. -* the **main toolbar** includes the New option to create files (pipelines and workflows) and metadata, and the options to manage projects and environments. -* the **perspectives toolbar** includes switcher icons between the various perspectives. +* The **main toolbar** offers a range of functions, including creating new files (such as pipelines and workflows) and adding metadata. It also provides options for managing projects and environments, as well as tools specifically for handling pipelines, workflows, and project settings. +* The **perspectives toolbar** includes switcher icons between the various perspectives. + + +** image:icons/data_orch.svg[width="24px"] xref:hop-gui/perspective-data-orchestration.adoc[Data Orchestration] + +** image:icons/execution.svg[width="24px"] xref:hop-gui/perspective-execution-information.adoc[Execution Information] + +** image:icons/gear.svg[width="24px"] xref:hop-gui/perspective-configuration.adoc[Configuration] + +** image:icons/metadata.svg[width="24px"] xref:hop-gui/perspective-metadata.adoc[Metadata] + +** image:icons/folder.svg[width="24px"] xref:hop-gui/perspective-file-explorer.adoc[File explorer] + +** image:icons/search.svg[width="24px"] xref:hop-gui/perspective-search.adoc[Search] + +** image:icons/plugin.svg[width="24px"] xref:hop-gui/perspective-plugin.adoc[Plugins explorer] + +** image:icons/neo4j_logo.svg[width="24px"] xref:hop-gui/perspective-neo4j.adoc[Neo4j] Let's see how we can use Hop Gui to do what Hop is all about: create pipelines and workflows! 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 81c5944dc98..a9787c2d8c0 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 @@ -41,7 +41,7 @@ Usage:
[-efhlp] [-c=] [-i=] [-k=] [-o=] [-s=] [-t=] -c, --target-config-file= - The target config file to write variable to + The target config file to write variables to -e, --skip-existing Skip existing files in the target folders -f, --skip-folders Skip import of sub-folders -h, --help Displays this help message and quits diff --git a/docs/hop-user-manual/modules/ROOT/pages/plugins/import/kettle-import.adoc b/docs/hop-user-manual/modules/ROOT/pages/plugins/import/kettle-import.adoc index 457db60ac2b..208e4ccfe40 100644 --- a/docs/hop-user-manual/modules/ROOT/pages/plugins/import/kettle-import.adoc +++ b/docs/hop-user-manual/modules/ROOT/pages/plugins/import/kettle-import.adoc @@ -71,3 +71,66 @@ You can change this behavior with the options: * `--skip-hidden` : Don't copy hidden files and folders like `.git`, `.gitignore` and so on * `--skip-existing` : Only copy files which haven't been copied yet +== Import Form Options + +When using the *Import from Kettle* form in the Hop GUI, the following options are available: + +[cols="1,2,1", options="header"] +|=== +| **Option** | **Description** | **Default Value** + +| *Import from* +| Select the source Kettle directory or project. +| - + +| *Import in existing project* +| Choose whether to import into an already existing Hop project. +| Selected + +| *Import in project* +| Specify the target project for the imported data. +| - + +| *Import to folder* +| Define the folder path where imported files will be stored. +| - + +To enable this option, deselect the *Import in existing project* option + +| *Path to `kettle.properties`* +| Specify the path to the `kettle.properties` file if it's not in the default location. +| - + +| *Path to `shared.xml`* +| Indicate the path to the `shared.xml` file if necessary. +| - + +| *Path to `jdbc.properties`* +| Provide the path to the `jdbc.properties` file if needed. +| - + +| *Skip existing target files?* +| Enable this option to skip copying files that are already present in the target directory. +| Selected + +| *Skip hidden files and folders?* +| Choose to exclude hidden files and folders during the import. +| Selected + +| *Skip folders in the source?* +| Opt to exclude sub-folders from being imported. +| Selected + +| *Target environment variables config file* +| Specify the name of the environment configuration file where variables from `kettle.properties` will be stored. +| `imported-env-conf.json` + +| *Pipeline default run configuration* +| Set the default run configuration for imported pipelines. +| - + +| *Workflow default run configuration* +| Set the default run configuration for imported workflows. +| - +|=== +