You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@hop.apache.org by ba...@apache.org on 2021/04/09 15:17:58 UTC
[incubator-hop-docs] branch asf-site updated: HOP-2773,
HOP-2774 (#68)
This is an automated email from the ASF dual-hosted git repository.
bartmaer pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/incubator-hop-docs.git
The following commit(s) were added to refs/heads/asf-site by this push:
new 49cfe8c HOP-2773, HOP-2774 (#68)
49cfe8c is described below
commit 49cfe8cdae845f7010b5d2ededf9ab98cb2c31bf
Author: Bart Maertens <ba...@know.bi>
AuthorDate: Fri Apr 9 17:16:54 2021 +0200
HOP-2773, HOP-2774 (#68)
* HOP-2774 updated main user manual page
* HOP-2774 updated hop gui overview, added placeholder for file dialog, perspectives
---
.../modules/ROOT/assets/images/icons/beam-logo.svg | 19 +++++++++++
.../modules/ROOT/assets/images/icons/developer.svg | 1 +
.../modules/ROOT/assets/images/icons/logo_icon.svg | 17 ++++++++++
.../modules/ROOT/assets/images/icons/pipeline.svg | 12 +++++++
.../modules/ROOT/assets/images/icons/play.svg | 1 +
.../modules/ROOT/assets/images/icons/workflow.svg | 12 +++++++
hop-user-manual/modules/ROOT/nav.adoc | 2 +-
.../modules/ROOT/pages/hop-gui/file-browser.adoc | 1 -
.../modules/ROOT/pages/hop-gui/file-dialog.adoc | 1 +
.../modules/ROOT/pages/hop-gui/index.adoc | 38 ++++------------------
.../modules/ROOT/pages/hop-gui/perspectives.adoc | 3 ++
.../modules/ROOT/pages/hop-gui/workitems.adoc | 28 ----------------
hop-user-manual/modules/ROOT/pages/index.adoc | 21 +++++++++++-
13 files changed, 93 insertions(+), 63 deletions(-)
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/beam-logo.svg b/hop-user-manual/modules/ROOT/assets/images/icons/beam-logo.svg
new file mode 100644
index 0000000..86d0033
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/beam-logo.svg
@@ -0,0 +1,19 @@
+<!--
+ 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.
+-->
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 114.07453 153.42"><defs><style>.cls-1{isolation:isolate;}.cls-2{opacity:0.15;}.cls-12,.cls-19,.cls-2{mix-blend-mode:multiply;}.cls-3{fill:url(#linear-gradient);}.cls-16,.cls-17,.cls-4,.cls-9{fill:#fff;}.cls-5{fill:#fee900;}.cls-6{fill:url(#linear-gradient-2);}.cls-7{fill:url(#linear-gradient-3);}.cls-8{opacity:0.65;fill:url(#linear-gradient-4);}.cls-9{opacity:0.9;}.cls-10,.cls-11{opacity:0.75; [...]
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/developer.svg b/hop-user-manual/modules/ROOT/assets/images/icons/developer.svg
new file mode 100644
index 0000000..5728238
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/developer.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" height="24px" viewBox="0 0 24 24" width="24px" fill="#000000"><path d="M0 0h24v24H0V0z" fill="none"/><path d="M9.4 16.6L4.8 12l4.6-4.6L8 6l-6 6 6 6 1.4-1.4zm5.2 0l4.6-4.6-4.6-4.6L16 6l6 6-6 6-1.4-1.4z"/></svg>
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/logo_icon.svg b/hop-user-manual/modules/ROOT/assets/images/icons/logo_icon.svg
new file mode 100644
index 0000000..1855c5c
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/logo_icon.svg
@@ -0,0 +1,17 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns:svg="http://www.w3.org/2000/svg"
+ xmlns="http://www.w3.org/2000/svg"
+ viewBox="0 0 48.000001 48.000002"
+ height="48pt"
+ width="48pt"
+ version="1.1">
+ <path
+ style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:sans-serif;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;font-feature-settings:normal;font-variation-settings:normal;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-st [...]
+ d="m 40.722651,30.877314 c 0,9.460954 -7.669665,17.130619 -17.130619,17.130619 -9.461195,0 -17.130858,-7.669665 -17.130858,-17.130619 0,-9.460952 7.669663,-17.130616 17.130858,-17.130616 9.460954,0 17.130619,7.669664 17.130619,17.130616"
+ />
+ <path
+ style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:sans-serif;font-variant-ligatures:normal;font-variant-position:normal;font-variant-caps:normal;font-variant-numeric:normal;font-variant-alternates:normal;font-variant-east-asian:normal;font-feature-settings:normal;font-variation-settings:normal;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-st [...]
+ d="m 27.151703,37.971659 c -2.366321,-2.670082 -3.42083,-6.253141 -2.976257,-10.096881 h 0.01132 l 1.963872,-13.93701 0.391377,-2.835928 4.837589,0.366587 -6.8561,-11.33552696 -8.485395,10.17318596 4.729754,0.358402 -0.490547,3.405664 -0.442166,3.107679 -1.3756,9.922857 h -2.33e-4 l -7.23e-4,0.0057 -0.106384,0.768315 h 0.03249 c -0.440721,5.246056 1.122626,10.164758 4.451748,13.921122 1.99468,2.250547 4.478941,3.914505 7.275398,4.924242 2.494611,-1.027791 4.69124,-2.627965 6.430538, [...]
+ />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/pipeline.svg b/hop-user-manual/modules/ROOT/assets/images/icons/pipeline.svg
new file mode 100644
index 0000000..d9cffcd
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/pipeline.svg
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ version="1.1"
+ viewBox="0 0 24 24"
+ height="24"
+ width="24">
+ <path
+ style="color:#000000;font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-size:medium;line-height:normal;font-family:sans-serif;text-indent:0;text-align:start;text-decoration:none;text-decoration-line:none;text-decoration-style:solid;text-decoration-color:#000000;letter-spacing:normal;word-spacing:normal;text-transform:none;writing-mode:lr-tb;direction:ltr;baseline-shift:baseline;text-anchor:start;white-space:normal;clip-rule:nonzero;display:inline;over [...]
+ d="m 16.180733,4.4778047 c -0.225712,-9.036e-4 -0.447587,0.00881 -0.664725,0.028102 C 13.778895,4.6602 12.310021,5.3650171 11.351491,5.8248197 10.345127,6.307569 9.0772298,7.0667616 7.7423285,7.3987385 6.4074274,7.7307155 5.1288775,7.6809549 3.8672819,6.5842574 A 1.0898647,1.2811267 0 1 0 2.5712276,8.644132 C 4.4094203,10.242054 6.4885583,10.329324 8.1935554,9.9053072 9.8985627,9.4812892 11.35277,8.5914861 12.17503,8.1970524 13.119637,7.7439286 14.355443,7.1782597 15.680225,7.06059 [...]
+ />
+</svg>
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/play.svg b/hop-user-manual/modules/ROOT/assets/images/icons/play.svg
new file mode 100644
index 0000000..1bb457c
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/play.svg
@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#000000"><g><rect fill="none" height="24" width="24"/></g><g><path d="M12,2C6.48,2,2,6.48,2,12s4.48,10,10,10s10-4.48,10-10S17.52,2,12,2z M9.5,16.5v-9l7,4.5L9.5,16.5z"/></g></svg>
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/assets/images/icons/workflow.svg b/hop-user-manual/modules/ROOT/assets/images/icons/workflow.svg
new file mode 100644
index 0000000..df16156
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/assets/images/icons/workflow.svg
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+ xmlns="http://www.w3.org/2000/svg"
+ width="512"
+ height="512"
+ version="1.1">
+ <g transform="translate(-379.90478,129.88361)">
+ <path
+ d="m 634.95062,-97.807163 c -8.92671,0 -17.8545,3.418519 -24.69475,10.258786 l -71.22658,71.226345 25.24726,25.2472345 60.7976,-60.7973805 c 2.73709,-2.737124 6.30586,-4.10273 9.87647,-4.10273 3.5708,0 7.1407,1.366519 9.87667,4.10273 L 692.3514,-4.3480664 666.65757,21.34622 h 76.70372 v -76.707316 l -25.76221,25.765802 -57.95351,-57.953083 c -6.84023,-6.840267 -15.76785,-10.258786 -24.69495,-10.258786 z M 453.92222,15.776774 479.68801,41.53917 421.7345,99.492456 c -6.84026,6.8402 [...]
+ style="color:#000000;clip-rule:nonzero;display:inline;overflow:visible;visibility:visible;opacity:1;isolation:auto;mix-blend-mode:normal;color-interpolation:sRGB;color-interpolation-filters:linearRGB;solid-color:#000000;solid-opacity:1;fill:#033d5d;fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:45.3993;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;color-rendering:auto;image-rendering:auto;shape [...]
+ </g>
+</svg>
diff --git a/hop-user-manual/modules/ROOT/nav.adoc b/hop-user-manual/modules/ROOT/nav.adoc
index dc0691a..0570186 100644
--- a/hop-user-manual/modules/ROOT/nav.adoc
+++ b/hop-user-manual/modules/ROOT/nav.adoc
@@ -9,7 +9,7 @@
** xref:getting-started/hop-next-steps.adoc[Next Steps]
* xref:concepts.adoc[Concepts]
* xref:hop-gui/index.adoc[Hop Gui]
-** xref:hop-gui/file-browser.adoc[File Browser]
+** xref:hop-gui/file-dialog.adoc[File Browser]
** xref:hop-gui/perspectives.adoc[Perspectives]
* xref:projects/index.adoc[Projects]
** xref:projects/projects-environments.adoc[Projects & Environments]
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/file-browser.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/file-browser.adoc
deleted file mode 100644
index 8b13789..0000000
--- a/hop-user-manual/modules/ROOT/pages/hop-gui/file-browser.adoc
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
new file mode 100644
index 0000000..3694a95
--- /dev/null
+++ b/hop-user-manual/modules/ROOT/pages/hop-gui/file-dialog.adoc
@@ -0,0 +1 @@
+= Hop File Chooser Dialog
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
index 5e85d6d..ae78a83 100644
--- a/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
+++ b/hop-user-manual/modules/ROOT/pages/hop-gui/index.adoc
@@ -2,38 +2,12 @@
= Hop Gui
-== https://hop.apache.org/manual/latest/hop-gui/workitems.html[Work Items]
+This page covers a number of topics that are very specific to working with Hop Gui.
-Work items are the building blocks for the start of your Hop journey. Different work items exist and can be used in the Hop environment. They are described in this section and in more detail in the specific Pipeline and Workflow sections.
+Refer to the corresponding chapters in the left-hand menu to learn more about creating and managing your Hop work.
-== https://hop.apache.org/manual/latest/hop-gui/pipelines/pipelines.html[Pipelines]
+Covered here are
-Pipelines are a main concept in Hop. A pipeline is a more granular item of work. The actual work is done in a Pipeline. Following sections describe the basic concepts of Pipelines.
-
-== https://hop.apache.org/manual/latest/hop-gui/workflows/workflows.html[Workflows]
-
-Workflows perform a variety of actions between a starting point and one or more endpoints. Following sections describe the basic concepts of Workflows.
-
-== Logging & Monitoring
-
-This section describes Logging and Monitoring for Hop and how to implement it on different levels.
-
-== https://hop.apache.org/manual/latest/hop-gui/environments/environments.html[Hop Environments]
-
-Hop Environments offer the possibility to manage different environments with specific configurations and variables. This section will describe the managing and use of Hop Environments
-
-== https://hop.apache.org/manual/latest/hop-gui/variables/variables.html[Variables]
-
-Variables provide a way to create a dynamic Hop solution. This section describes how they can be used and configured.
-
-== Working with Git
-
-Hop can be connected to your Git Repository, this section will explain more into detail how to use and configure Hop and Git.
-
-== Metastore Browser
-
-The metastore browser contains all objects in one location. This section handles the metastore browser and the editors of the metastore elements.
-
-== https://hop.apache.org/manual/latest/hop-gui/shortcuts.html[Hop Shortcuts]
-
-Hop contains a lot of keyboard shortcuts to provide an alternative way to do something that you’d typically do with a mouse. The section below contains a list of shortcuts and their actions.
\ No newline at end of file
+* 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
+* xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]: a list of the keyboard shortcuts that are available in Hop Gui.
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
index e69de29..a13e074 100644
--- a/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
+++ b/hop-user-manual/modules/ROOT/pages/hop-gui/perspectives.adoc
@@ -0,0 +1,3 @@
+= Hop Gui Perspectives
+
+coming soon
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/hop-gui/workitems.adoc b/hop-user-manual/modules/ROOT/pages/hop-gui/workitems.adoc
deleted file mode 100644
index 6bf13b4..0000000
--- a/hop-user-manual/modules/ROOT/pages/hop-gui/workitems.adoc
+++ /dev/null
@@ -1,28 +0,0 @@
-[[WorkItems]]
-:imagesdir: ../assets/images
-= Work Items
-
-From the 'New' menu, there are a number of work items you can create.
-There are several ways to access the 'New Work Item' dialog:
-
-* CTRL-N
-* File -> New
-* Click the 'New' icon in the upper left corner image:hop-gui/new.svg[New, 20, title="New", ]
-
-You'll be presented with the dialog shown below:
-
-image::hop-gui/new-work-item.png[New Work Item, width="75%"]
-
-The work items you can create from this dialog are:
-
-* Beam File Definition
-* Data Set
-* Git Repository
-* https://hop.apache.org/manual/latest/hop-server/index.html[Hop Server]
-* Partition Schema
-* Pipeline
-* Pipeline Run Configuration
-* Pipeline Unit Test
-* Relational Database Connection
-* Workflow
-* Workflow Run Configuration
\ No newline at end of file
diff --git a/hop-user-manual/modules/ROOT/pages/index.adoc b/hop-user-manual/modules/ROOT/pages/index.adoc
index c6259c5..614e869 100644
--- a/hop-user-manual/modules/ROOT/pages/index.adoc
+++ b/hop-user-manual/modules/ROOT/pages/index.adoc
@@ -1,4 +1,23 @@
[[Index]]
+
+:imagesdir: ../assets/images
+
= Index Page
-Welcome to the Apache Hop (Incubating) documentation
\ No newline at end of file
+The Apache Hop (Incubating) User Manual contains all the information you need to develop and deploy data solutions with Apache Hop.
+
+We've listed a number of starting points that might find useful to you. Check the full list of topics on the left hand side.
+If you're a developer and want to extend Hop, want to build new functionality or want to fix a bug you found, check the http://hop.apache.org/dev-manual/latest/[developer documentation]
+
+TIP: Hop treats documentation as any other part of software that can have bugs or missing features. If you find any incorrect information or are missing a crucial piece of documentation, please http://hop.apache.org/community/contribution-guides/jira-guide/[create a JIRA ticket].
+
+[%noheader, width="90%", frame=none,grid=none]
+|====
+|image:icons/developer.svg[width="50px"]|Check the http://hop.apache.org/community/contribution-guides/documentation-contribution-guide/[documentation contribution guide] if you'd like to help us improve the Hop documentation.
+|image:icons/play.svg[width="50px"]|The xref:getting-started/index.adoc[Getting Started Guide] will help you to get started with Hop in no time
+|image:icons/logo_icon.svg[width="50px"]|Check the xref:hop-gui/index.adoc[Hop Gui] guide for information about how to develop, run, test, debug and deploy Hop pipelines
+|image:icons/workflow.svg[width="50px"]|xref:workflow/workflows.adoc[Workflows] are Hop's tool to orchestrate workflows and pipelines, perform environment validations, error handling and much more with the available xref:workflow/actions.adoc[actions]
+|image:icons/pipeline.svg[width="50px"]|xref:pipeline/pipelines.adoc[Pipelines] are Hop's work horse: read from sources, write to targets and perform just about any manipulation on your data through hundreds of xref:pipeline/transforms.adoc[transforms].
+|image:icons/database.svg[width="50px"]|Check the list of supported xref:database/databases.adoc[databases]
+|image:icons/beam-logo.svg[width="50px"]|Check the xref:pipeline/pipeline-run-configurations/pipeline-run-configurations.adoc[Run Configurations] if you want to find out more about running your Hop pipelines on Apache Spark, Apache Flink or Google Dataflow over Apache Beam.
+|====