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 65dc1dc HOP-3267 added descriptions for best practices, getting
started and hop gui
new db7100d Merge pull request #1055 from bamaer/HOP-3267
65dc1dc is described below
commit 65dc1dc5ad7c730c56f9ac9722cc395deaa8ef1c
Author: Bart Maertens <[email protected]>
AuthorDate: Mon Sep 13 21:25:42 2021 +0200
HOP-3267 added descriptions for best practices, getting started and hop gui
---
.../modules/ROOT/pages/best-practices/index.adoc | 1 +
.../modules/ROOT/pages/getting-started/hop-concepts.adoc | 1 +
.../ROOT/pages/getting-started/hop-download-install.adoc | 1 +
.../ROOT/pages/getting-started/hop-gui-pipelines.adoc | 1 +
.../ROOT/pages/getting-started/hop-gui-workflows.adoc | 1 +
.../modules/ROOT/pages/getting-started/hop-gui.adoc | 1 +
.../modules/ROOT/pages/getting-started/hop-next-steps.adoc | 1 +
.../modules/ROOT/pages/getting-started/hop-tools.adoc | 1 +
.../ROOT/pages/getting-started/hop-what-is-hop.adoc | 1 +
.../modules/ROOT/pages/getting-started/index.adoc | 1 +
.../modules/ROOT/pages/hop-gui/file-dialog.adoc | 1 +
.../modules/ROOT/pages/hop-gui/hop-gui-git.adoc | 1 +
.../modules/ROOT/pages/hop-gui/hop-web.adoc | 14 +++-----------
docs/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc | 13 ++++++++++---
.../modules/ROOT/pages/hop-gui/perspectives.adoc | 3 ++-
.../modules/ROOT/pages/hop-gui/shortcuts.adoc | 6 ++++++
16 files changed, 33 insertions(+), 15 deletions(-)
diff --git a/docs/hop-user-manual/modules/ROOT/pages/best-practices/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/best-practices/index.adoc
index 51a5f55..bc59c22 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/best-practices/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/best-practices/index.adoc
@@ -16,6 +16,7 @@ under the License.
////
[[BestPractices]]
:imagesdir: ../assets/images
+:description: Apache Hop (Incubating) best practices are a set of guiding
principles. These best practices apply to the way you design, run, test, deploy
and maintain Hop project.
= Best practices
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-concepts.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-concepts.adoc
index 0d86fa8..d353b72 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-concepts.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-concepts.adoc
@@ -17,6 +17,7 @@ under the License.
[[HopConcepts]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (2/8): before going into the details of
workflows and pipelines, we'll walk through the core terminology used in Hop."
= Hop Concepts
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-download-install.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-download-install.adoc
index bc322b7..417cf6c 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-download-install.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-download-install.adoc
@@ -17,6 +17,7 @@ under the License.
[[DownloadInstall]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (3/8): Installing Hop is as easy and accessible
as possible: download, unzip, start."
= Download and Install Hop
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-pipelines.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-pipelines.adoc
index 3ce60c6..30afe69 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-pipelines.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-pipelines.adoc
@@ -17,6 +17,7 @@ under the License.
[[HopGuiPipelines]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (6/8): Pipelines are one of the two main file
types in Hop. Learn how to add transforms and connect them through hops before
your run, preview and debug your first pipeline. "
= Pipelines
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-workflows.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-workflows.adoc
index 2e25f96..ad90476 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-workflows.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-gui-workflows.adoc
@@ -17,6 +17,7 @@ under the License.
[[HopGuiWorkflows]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (7/8): Workflows in Hop are where you'll do
most of the orchestration work: set the stage by fetching files, checking
resource availability etc before your start to do actually run workflows and
pipelines. We'll walk through what it takes to build and run a basic first
workflow."
= Workflows
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 fedbe2b..3258d7c 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
@@ -17,6 +17,7 @@ under the License.
[[HopGui]]
:imagesdir: ../../assets/images/
:page-pagination:
+:description: "Getting Started (5/8): Hop Gui is Hop's visual development
environment where you design, run and debug your workflows and pipelines. In
this step, we'll take a quick tour of the user interface and describe some of
the functionalities in Hop GUI."
= Hop Gui
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-next-steps.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-next-steps.adoc
index deeb697..ce2f9ca 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-next-steps.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-next-steps.adoc
@@ -18,6 +18,7 @@ under the License.
:imagesdir: ../../assets/images
:page-pagination:
:page-pagination-no-next:
+:description: "Getting Started (8/8): You now know the basic Hop terminology
and tools, and you've created and have run your first pipeline and workflow.
Here's an overview of topics you could explore to continue building your Hop
knowledge."
= Next Steps
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-tools.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-tools.adoc
index 9fa5b11..542b36c 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-tools.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-tools.adoc
@@ -17,6 +17,7 @@ under the License.
[[HopTools]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (4/8): Hop comes with a number of GUI and
command line tools to not only design and run workflows and pipelines, but also
to manage your projects and environments, to search import, translate and more."
= Hop Tools
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-what-is-hop.adoc
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-what-is-hop.adoc
index 65b5758..fd9b5fc 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-what-is-hop.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/getting-started/hop-what-is-hop.adoc
@@ -17,6 +17,7 @@ under the License.
[[WhatIsHop]]
:imagesdir: ../../assets/images
:page-pagination:
+:description: "Getting Started (1/8): before we're diving into Hop, we'll have
a quick look at the visual design, metadata, kernel + plugin architecture and
runtimes"
= What is Apache Hop?
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 3d62644..06be378 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
@@ -18,6 +18,7 @@ under the License.
:imagesdir: ../../assets/images
:page-pagination:
:page-pagination-no-back:
+:description: The Apache Hop (Incubating) Getting Started guide walks new Hop
users through the Hop concepts and the bare necessities to get started building
workflows and pipelines.
= Getting Started
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 da8ee55..3653e1f 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
@@ -15,6 +15,7 @@ specific language governing permissions and limitations
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
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
index 72fc1d1..c675396 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-gui-git.adoc
@@ -15,6 +15,7 @@ specific language governing permissions and limitations
under the License.
////
:imagesdir: ../../assets/images
+:description: "Managing your work in version control is crucial in serious Hop
projects. Hop's file explorer perspective offers the basic functionality to
manage your work in git: pull, push, visual diff, commit etc are all available
from a user friendly ui."
= Working with git
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
index 4600d62..db20ed6 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/hop-web.adoc
@@ -15,18 +15,12 @@ specific language governing permissions and limitations
under the License.
////
:imagesdir: ../assets/images
+:description: "Hop Web is a browser based alternative for desktop Hop Gui. Hop
Web offers exactly the same functionality as the desktop client, you'll hardly
notice any difference."
-= Hop Web (Experimental)
+= Hop Web
Hop Web is a web based Hop Gui version.
-Hop Gui was designed from the ground up to be web-ready.
-You'll barely notice any difference between working in the Hop Gui _fat
client_ or Hop Web.
-
-WARNING: Even though Hop Web is largely functional, there still are a couple
of bugs that need to be ironed out before it is ready for prime time.
-The most important issues are:
-
-* copy/paste does not work
-* keyboard shortcuts do not work, do not overrule your browser's default etc.
+Hop Gui was designed from the ground up to be web-ready. You'll barely notice
any difference between working in the Hop Gui _fat client_ or Hop Web.
== Getting Hop Web
@@ -37,8 +31,6 @@ This continously updated docker image is by far the easiest
way to try out Hop W
Pull the latest build with: `docker pull apache/incubator-hop-web`.
-TIP: Given Hop Web's experimental status, you're strongly encouraged to test
with the latest and greatest image available.
-
Once the image has been pulled, start Hop Web with `docker run -p 8080:8080
apache/incubator-hop-web:latest`
The Hop Web container should only take a couple of seconds to start.
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 c3a5056..63ff530 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
@@ -15,13 +15,20 @@ specific language governing permissions and limitations
under the License.
////
[[HopGui]]
+
+: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
-This page covers a number of topics that are very specific to working with 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.
+
+You'll spend most of your time building, previewing running and debugging
workflows and pipelines, but there's also a lot of configuration that can be
done from Hop Gui's metadata perspective, you can search for any metadata with
the search perspective, manage a variety of files and even version control them
from the file explorer perspective and much more.
-Refer to the corresponding chapters in the left-hand menu to learn more about
creating and managing your Hop work.
+This page covers a number of topics that are very specific to working with Hop
Gui.
+Check the chapters on xref:/pipeline/pipelines.adoc[pipelines] and
xref:/workflow/workflows.adoc[workflows] to learn more about creating and
running pipelines and workflows in Hop Gui.
-Covered here are
+Covered here are:
* xref:hop-gui/file-dialog.adoc[File Dialog]: the versatile Hop file browser
and chooser dialog.
* xref:hop-gui/perspectives.adoc[Perspectives]: the various perspectives in
the 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 46e1845..c779284 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
@@ -16,10 +16,11 @@ under the License.
////
= 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."
Hop comes with a number of perspectives built in.
-Change the current perspectives by clicking on the icon in the left hand
toolbar, or through the corresponding keyboard shortcut.
+Change the current perspectives by clicking on the icon in the left-hand
toolbar, or through the corresponding keyboard shortcut.
Use the keyboard shortcuts `CTRL-SHIFT-arrow-up` and `CTRL-SHIFT-arrow-down`
to cycle through perspectives.
include::perspective-data-orchestration.adoc[]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/shortcuts.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/shortcuts.adoc
index 0928c97..75d1161 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/shortcuts.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/shortcuts.adoc
@@ -16,6 +16,8 @@ under the License.
////
[[Shortcuts]]
:imagesdir: ../assets/images
+:description: "A lot of actions in Hop can be performed significantly faster
through keyboard shortcuts. This page provides an overview of all the available
keyboard shortcuts in Hop Gui."
+
= Hop Shortcuts
The table below lists the main shortcuts in Hop.
@@ -64,6 +66,10 @@ Most of the times you can replace ctrl with cmd.
|Ctrl + =|Zoom In on your canvas
|Ctrl + -|Zoom out on your canvas
|Ctrl + 0|Reset the zoom percentage to 100%
+|Ctrl + click|On hops to quickly enable/disable
+|Ctr-Shift-Click|Use this shortcut on workflow actions and pipeline transforms
that use another workflow or pipeline to open.
+|mouse over + z|Hover over a workflow action or pipeline transform that uses
another workflow or pipeline to open (similar to option above)
+|mouse over transform + space|Opens the outgoing fields
|===
== Perspective Shortcuts
