This is an automated email from the ASF dual-hosted git repository.
hansva pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hop.git
The following commit(s) were added to refs/heads/main by this push:
new 19e0bec46f Issue #8188 : fold the technical documentation into the
user and dev manuals (#8189)
19e0bec46f is described below
commit 19e0bec46f579c38a2e11672862daecd6a4991ce
Author: Hans Van Akelyen <[email protected]>
AuthorDate: Mon Aug 31 11:03:06 2026 +0200
Issue #8188 : fold the technical documentation into the user and dev
manuals (#8189)
The tech manual held 12 pages, half of them untouched since 2021, an empty
"Getting Started" stub, and a logging plugin page pointing at source code
that
does not exist. "Technical" was never a rule a contributor could apply, and
it
showed: Docker was documented in all three manuals at once.
Every page moves to the manual that already owns its subject:
* Kettle/PDI pages to the user manual, in the nav after Getting Started
* docker-container and hop-web-docker to the user manual
* disable-ui-elements to the user manual under Hop Gui
* the two hop-import pages merged into one: what gets converted goes to the
hop-import tool page, the fuller dialog table to the GUI walkthrough
* logging internals (HopLogStore, LoggingRegistry, reading a channel buffer)
into the developer manual's logging page
* the logo page and its 30 image copies drop out: hop.apache.org already
hosts the same brand assets under /graphical_resources/
The 21 xrefs that pointed into the tech manual now point at the new
locations,
and writing-documentation.adoc states the two-manual rule explicitly.
Co-authored-by: Claude Opus 5 <[email protected]>
---
.../pages/apache-release/creating-a-release.adoc | 1 -
.../pages/architecture/logging-and-debugging.adoc | 19 +++
.../modules/ROOT/pages/hopweb/developer-guide.adoc | 2 +-
.../modules/ROOT/pages/svg-files.adoc | 2 +-
.../modules/ROOT/pages/writing-documentation.adoc | 5 +-
docs/hop-tech-manual/antora.yml | 23 ----
.../ROOT/assets/attachments/BrandGuideline_Hop.pdf | Bin 248369 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-1.jpg | Bin 1440960 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-10.jpg | Bin 1308954 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-11.jpg | Bin 1306991 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-12.jpg | Bin 1306689 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-2.jpg | Bin 1441073 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-3.jpg | Bin 1425149 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-4.jpg | Bin 1471870 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-5.jpg | Bin 1324288 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-6.jpg | Bin 1323853 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-7.jpg | Bin 1311014 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-8.jpg | Bin 1303627 -> 0 bytes
.../images/logo/CMYK/jpg/HOP_logo_CMYK-9.jpg | Bin 1307910 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-1.jpg | Bin 555813 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-10.jpg | Bin 490003 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-11.jpg | Bin 509641 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-12.jpg | Bin 509538 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-2.jpg | Bin 555618 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-3.jpg | Bin 576545 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-4.jpg | Bin 588865 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-5.jpg | Bin 527199 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-6.jpg | Bin 526923 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-7.jpg | Bin 480043 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-8.jpg | Bin 479315 -> 0 bytes
.../assets/images/logo/RGB/jpg/HOP_logo_RGB-9.jpg | Bin 489101 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-1.png | Bin 113224 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-11.png | Bin 108306 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-12.png | Bin 108195 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-2.png | Bin 113330 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-5.png | Bin 112113 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-6.png | Bin 112647 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-7.png | Bin 88695 -> 0 bytes
.../assets/images/logo/RGB/png/HOP_logo_RGB-8.png | Bin 88680 -> 0 bytes
docs/hop-tech-manual/modules/ROOT/nav.adoc | 29 -----
.../modules/ROOT/pages/getting-started.adoc | 18 ---
.../modules/ROOT/pages/hop-logo-and-icons.adoc | 90 --------------
.../ROOT/pages/hop-vs-kettle/hop-import.adoc | 133 ---------------------
docs/hop-tech-manual/modules/ROOT/pages/index.adoc | 23 ----
.../ROOT/pages/logging/logging-architecture.adoc | 37 ------
.../ROOT/pages/logging/logging-plugins.adoc | 22 ----
.../modules/ROOT/pages/logging/udjc-logging.adoc | 30 -----
.../assets/images/hop-import/import-dialog.png | Bin
.../assets/images/hop-import/import-report.png | Bin
.../ROOT/assets/images/hop-import/menu-import.png | Bin
docs/hop-user-manual/modules/ROOT/nav.adoc | 7 ++
.../modules/ROOT/pages/docker-container.adoc | 8 +-
.../ROOT/pages/getting-started/hop-tools.adoc | 4 +-
.../ROOT/pages/hop-gui}/disable-ui-elements.adoc | 0
.../modules/ROOT/pages/hop-gui/hop-web.adoc | 8 +-
.../modules/ROOT/pages/hop-gui/index.adoc | 2 +-
.../ROOT/pages/hop-server/deploy-git-checkout.adoc | 2 +-
.../pages/hop-server/deploy-project-image.adoc | 4 +-
.../modules/ROOT/pages/hop-server/index.adoc | 2 +-
.../modules/ROOT/pages/hop-tools/hop-import.adoc | 48 ++++++++
.../ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc | 0
.../pages/hop-vs-kettle/if-you-know-kettle.adoc | 8 +-
.../hop-vs-kettle/import-kettle-projects.adoc | 25 ++--
.../modules/ROOT/pages/hop-vs-kettle/index.adoc | 0
.../modules/ROOT/pages/hop-web-docker.adoc | 28 ++---
.../apache-hop-web-services-docker.adoc | 2 +-
.../how-to-guides/run-hop-in-apache-airflow.adoc | 2 +-
.../ROOT/pages/installation-configuration.adoc | 4 +-
.../modules/ROOT/pages/projects/index.adoc | 2 +-
69 files changed, 132 insertions(+), 458 deletions(-)
diff --git
a/docs/hop-dev-manual/modules/ROOT/pages/apache-release/creating-a-release.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/apache-release/creating-a-release.adoc
index 8963845987..2fd34bbb4a 100644
---
a/docs/hop-dev-manual/modules/ROOT/pages/apache-release/creating-a-release.adoc
+++
b/docs/hop-dev-manual/modules/ROOT/pages/apache-release/creating-a-release.adoc
@@ -397,7 +397,6 @@ Cheers,
Update following files and set the correct documentation version and name
* docs/hop-user-manual/antora.yml
-* docs/hop-tech-manual/antora.yml
* docs/hop-dev-manual/antora.yml
Remove the `prerelease` and `display_version` attributes
diff --git
a/docs/hop-dev-manual/modules/ROOT/pages/architecture/logging-and-debugging.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/architecture/logging-and-debugging.adoc
index bf564355a5..6ea4105a9d 100644
---
a/docs/hop-dev-manual/modules/ROOT/pages/architecture/logging-and-debugging.adoc
+++
b/docs/hop-dev-manual/modules/ROOT/pages/architecture/logging-and-debugging.adoc
@@ -30,6 +30,25 @@ Seven levels, from `LogLevel`:
The level is set per run, and a channel logs only what its level allows.
`ROWLEVEL` logs per row and is a debugging tool, not something to leave on.
+=== Where the log lines end up
+
+`HopLogStore` is the central store every channel appends to.
+It is initialized by `HopEnvironment.init()`, so nothing is captured before
that call.
+
+Every runtime object — `IPipelineEngine`, `IWorkflowEngine`, a transform, a
database connection — owns a log channel id, and that id is the key into the
store.
+The parent/child relations between those channels live in
`LoggingRegistry.getInstance()`.
+
+To read back what an object logged, ask the store's appender for that
channel's buffer:
+
+[source,java]
+----
+String logText =
+
HopLogStore.getInstance().getAppender().getBuffer(pipeline.getLogChannelId(),
true);
+----
+
+The second argument clears the buffer as it is read.
+This is the same path a `logBasic()` call from a
xref:manual::pipeline/transforms/userdefinedjavaclass.adoc[User Defined Java
Class] takes: the transform's own channel, the same store.
+
== Attaching a debugger
The launcher scripts in the distribution read `HOP_OPTIONS`, and each ships
with a commented-out JDWP line:
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
index 9219cb6e5f..ef366bd7b5 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/developer-guide.adoc
@@ -121,4 +121,4 @@ The Hop Web image uses `/config` for an optional Tomcat
`tomcat-users.xml` / `we
In the same way you can set the standard variable `HOP_AUDIT_FOLDER` to store
GUI auditing and logging information.
-For the operator-facing volume layout, Compose example, and upgrade procedure,
see xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker: persistence and
upgrades].
+For the operator-facing volume layout, Compose example, and upgrade procedure,
see xref:manual::hop-web-docker.adoc[Hop Web in Docker: persistence and
upgrades].
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/svg-files.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/svg-files.adoc
index d069a37d79..e459dfea30 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/svg-files.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/svg-files.adoc
@@ -34,4 +34,4 @@ Check with the other devs and on
https://www.apache.org/legal/resolved.html[this
== Colors scheme
-If you want to re-color or create icons that fit the Hop look & feel, please
refer to
http://hop.apache.org/tech-manual/latest/_attachments/BrandGuideline_Hop.pdf[Hop
Branding guide] for some guidance.
\ No newline at end of file
+If you want to re-color or create icons that fit the Hop look & feel, please
refer to https://hop.apache.org/graphical_resources/brand_guideline_hop.pdf[Hop
Branding guide] for some guidance.
\ No newline at end of file
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/writing-documentation.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/writing-documentation.adoc
index eae8901ef5..6c42ff53d6 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/writing-documentation.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/writing-documentation.adoc
@@ -31,8 +31,7 @@ For people *using* Hop. Every transform, action and metadata
type has a page her
`docs/hop-dev-manual`::
This manual: for people working on Hop or writing plugins for it.
-`docs/hop-tech-manual`::
-Deeper technical notes that are neither user-facing nor about contributing.
+There is no third manual: if a page tells someone how to *use* or *operate*
Hop it belongs in the user manual, and if it tells someone how to *build,
extend or release* Hop it belongs here.
Inside a manual the layout is always `modules/ROOT/`, with `pages/` for the
content, `assets/images/` for images, `nav.adoc` for the navigation tree, and —
in the user manual — `templates/` with starting points for a plugin, sample or
FAQ page.
@@ -44,7 +43,7 @@ Without it, Apache RAT fails the build.
. Add a `:description:` line. It is used as the page summary and for search.
. Add the page to `modules/ROOT/nav.adoc`, or it will not be published.
. Link between pages with an `xref` macro, with the path relative to `pages/`
rather than to the current file: `+xref:database/index.adoc[Database plugins]+`.
-Across manuals, prefix the component name — `manual`, `dev-manual` or
`tech-manual`: `+xref:manual::pipeline/transforms/tableinput.adoc[Table
input]+`.
+Across manuals, prefix the component name — `manual` or `dev-manual`:
`+xref:manual::pipeline/transforms/tableinput.adoc[Table input]+`.
== Documenting a plugin
diff --git a/docs/hop-tech-manual/antora.yml b/docs/hop-tech-manual/antora.yml
deleted file mode 100644
index eea4dc4bee..0000000000
--- a/docs/hop-tech-manual/antora.yml
+++ /dev/null
@@ -1,23 +0,0 @@
-# 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.
-
-name: tech-manual
-title: Technical Documentation
-version: 2.20.0
-prerelease: true
-nav:
- - modules/ROOT/nav.adoc
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/attachments/BrandGuideline_Hop.pdf
b/docs/hop-tech-manual/modules/ROOT/assets/attachments/BrandGuideline_Hop.pdf
deleted file mode 100644
index d6da1ab4a0..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/attachments/BrandGuideline_Hop.pdf
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-1.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-1.jpg
deleted file mode 100644
index 7320934ef5..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-1.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-10.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-10.jpg
deleted file mode 100644
index 3bbb39e070..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-10.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-11.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-11.jpg
deleted file mode 100644
index 2565e26b1d..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-11.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-12.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-12.jpg
deleted file mode 100644
index 7bec0e186a..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-12.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-2.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-2.jpg
deleted file mode 100644
index 705d5edd60..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-2.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-3.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-3.jpg
deleted file mode 100644
index 3d973336e8..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-3.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-4.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-4.jpg
deleted file mode 100644
index 5c00fb992c..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-4.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-5.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-5.jpg
deleted file mode 100644
index ccf5f109e8..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-5.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-6.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-6.jpg
deleted file mode 100644
index 31e0a61a24..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-6.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-7.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-7.jpg
deleted file mode 100644
index 0dbef54bd1..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-7.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-8.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-8.jpg
deleted file mode 100644
index 3afd059b8c..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-8.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-9.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-9.jpg
deleted file mode 100644
index de90204ea1..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/CMYK/jpg/HOP_logo_CMYK-9.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-1.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-1.jpg
deleted file mode 100644
index 0cfde08532..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-1.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-10.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-10.jpg
deleted file mode 100644
index c4a927180e..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-10.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-11.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-11.jpg
deleted file mode 100644
index 290fab074f..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-11.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-12.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-12.jpg
deleted file mode 100644
index 5c7c21c54d..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-12.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-2.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-2.jpg
deleted file mode 100644
index b9c2f9d28d..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-2.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-3.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-3.jpg
deleted file mode 100644
index 035c9b54ab..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-3.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-4.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-4.jpg
deleted file mode 100644
index b0d38dd089..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-4.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-5.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-5.jpg
deleted file mode 100644
index 7db928d6c6..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-5.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-6.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-6.jpg
deleted file mode 100644
index 88891d3a95..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-6.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-7.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-7.jpg
deleted file mode 100644
index d21332ec63..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-7.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-8.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-8.jpg
deleted file mode 100644
index 992ed13829..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-8.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-9.jpg
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-9.jpg
deleted file mode 100644
index baf99cc003..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/jpg/HOP_logo_RGB-9.jpg
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-1.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-1.png
deleted file mode 100644
index 24880fc894..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-1.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-11.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-11.png
deleted file mode 100644
index 029fb1984d..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-11.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-12.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-12.png
deleted file mode 100644
index a9f13c47ff..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-12.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-2.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-2.png
deleted file mode 100644
index 7c3b9def43..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-2.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-5.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-5.png
deleted file mode 100644
index 6c78cfe295..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-5.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-6.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-6.png
deleted file mode 100644
index 1a514eed9c..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-6.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-7.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-7.png
deleted file mode 100644
index 63dfe2560c..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-7.png
and /dev/null differ
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-8.png
b/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-8.png
deleted file mode 100644
index 83480fcd97..0000000000
Binary files
a/docs/hop-tech-manual/modules/ROOT/assets/images/logo/RGB/png/HOP_logo_RGB-8.png
and /dev/null differ
diff --git a/docs/hop-tech-manual/modules/ROOT/nav.adoc
b/docs/hop-tech-manual/modules/ROOT/nav.adoc
deleted file mode 100644
index 48b9c1304f..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/nav.adoc
+++ /dev/null
@@ -1,29 +0,0 @@
-////
-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.
-////
-* xref:getting-started.adoc[Getting started]
-* xref:docker-container.adoc[Docker container]
-* xref:hop-web-docker.adoc[Hop Web in Docker]
-* xref:disable-ui-elements.adoc[Disable UI elements]
-* xref:hop-vs-kettle/index.adoc[Kettle/PDI and Hop]
-** xref:hop-vs-kettle/hop-vs-kettle.adoc[Hop vs Kettle]
-** xref:hop-vs-kettle/if-you-know-kettle.adoc[If you know Kettle]
-** xref:hop-vs-kettle/import-kettle-projects.adoc[Upgrade Kettle to Hop]
-** xref:hop-vs-kettle/hop-import.adoc[Hop Import]
-* xref:logging/logging-architecture.adoc[Logging Architecture]
-** xref:logging/udjc-logging.adoc[Logging from UDJC]
-** xref:logging/logging-plugins.adoc[Logging Plugin Architecture]
-* xref:hop-logo-and-icons.adoc[Hop logo and icons]
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/getting-started.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/getting-started.adoc
deleted file mode 100644
index d3d70a4e4f..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/getting-started.adoc
+++ /dev/null
@@ -1,18 +0,0 @@
-////
-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.
-////
-[[GettingStarted-GettingStarted]]
-= Getting Started
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/hop-logo-and-icons.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/hop-logo-and-icons.adoc
deleted file mode 100644
index e888be90bb..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/hop-logo-and-icons.adoc
+++ /dev/null
@@ -1,90 +0,0 @@
-////
-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.
-////
-[[HopLogoAndIcons-HopLogoAndIcons]]
-= Hop Logo and Icons
-
-== The Apache Hop logo and icon
-
-The Apache Hop logo should be used as the main reference to the Apache Hop
project.
-
-The Apache Hop icon should be used in graphical user interfaces like Apache
Hop's Hop Gui. The icon should not be used as a replacement for the Apache Hop
logo.
-
-== CMYK for Printing
-
-=== Logo
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-4.jpg[HOP_logo_CMYK-4.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-2.jpg[HOP_logo_CMYK-2.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-1.jpg[HOP_logo_CMYK-1.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-3.jpg[HOP_logo_CMYK-3.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-5.jpg[HOP_logo_CMYK-5.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-6.jpg[HOP_logo_CMYK-6.jpg, width="50%"]
-
-=== Icon
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-10.jpg[HOP_logo_CMYK-10.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-7.jpg[HOP_logo_CMYK-7.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-8.jpg[HOP_logo_CMYK-8.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-9.jpg[HOP_logo_CMYK-9.jpg, width="50%"]
-
-image::logo/CMYK/jpg/HOP_logo_CMYK-12.jpg[HOP_logo_CMYK-12.jpg, width="50%"]
-
-== RGB for Web usage
-
-=== Logo
-
-image::logo/RGB/jpg/HOP_logo_RGB-4.jpg[HOP_logo_RGB-4.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-1.jpg[HOP_logo_RGB-1.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-2.jpg[HOP_logo_RGB-2.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-3.jpg[HOP_logo_RGB-3.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-5.jpg[HOP_logo_RGB-5.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-6.jpg[HOP_logo_RGB-6.jpg, width="50%"]
-
-=== Icon
-
-image::logo/RGB/jpg/HOP_logo_RGB-10.jpg[HOP_logo_RGB-10.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-7.jpg[HOP_logo_RGB-7.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-8.jpg[HOP_logo_RGB-8.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-9.jpg[HOP_logo_RGB-9.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-11.jpg[HOP_logo_RGB-11.jpg, width="50%"]
-
-image::logo/RGB/jpg/HOP_logo_RGB-12.jpg[HOP_logo_RGB-12.jpg, width="50%"]
-
-== Style guide:
-
-link:{attachmentsdir}/BrandGuideline_Hop.pdf[BrandGuideline_Hop.pdf]
-
-
-
-
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/hop-import.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/hop-import.adoc
deleted file mode 100644
index 40782d0ce1..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/hop-import.adoc
+++ /dev/null
@@ -1,133 +0,0 @@
-////
-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.
-////
-:openvar: ${
-:closevar: }
-:description: Hop is an independent platform that originates from the same
code base as Kettle (Pentaho Data Integration). Even though Hop and Kettle are
not compatible, you can upgrade your existing Kettle projects by simply
importing them into Hop.
-
-= Kettle Import
-
-Whenever you want to import metadata from Kettle (Pentaho Data Integration)
you can use this plugin.
-
-== Usage
-
-You can use it through the `File / Import from Kettle/PDI` menu in the Hop GUI
or using the `hop-import` script with the `--type kettle` option.
-
-== Functionality
-
-In general the plugin copies Kettle files and non-Kettle files.
-
-=== Kettle files
-
-|===
-|File |Conversion
-
-|Transformations
-|Kettle transformation files (.ktr extension) are converted to Hop pipelines.
-During this process the XML metadata is converted to the appropriate Hop
format.
-
-|Jobs
-|Kettle job files (.kjb extension) are converted to Hop workflows.
-During this process the XML metadata is converted to the appropriate Hop
format.
-
-|kettle.properties
-|The Kettle properties file in your .kettle folder (typically found in the
home directory or `{openvar}KETTLE_HOME{closevar}`) often contains variables
and values regarding your environment.
-These variables and values are converted into an environment configuration
file if you specified the `-c` or `--target-config-file` option.
-When you create an environment in Hop you can simply add this file to it to
make everything work.
-If the configuration file already exists it will be updated, not overwritten.
-The description of the newly imported variables is set to `Imported from
Kettle` to indicate that it's new.
-Values of existing variables are overwritten and the existing description is
kept.
-
-|shared.xml
-|The shared.xml file in your .kettle folder (typically found in the home
directory or `{openvar}KETTLE_HOME{closevar}`) often contains connections which
are shared across many transformations and jobs.
-These connections are imported as Relational Database Connection metadata
stored in the target folder `metadata/rdbms` folder.
-
-|jdbc.properties
-|A jdbc.properties file sometimes contains relational database metadata which
is converted into generic RDBMS connections metadata.
-|===
-
-=== Non-Kettle files
-
-Non-Kettle files like text files, JSON, XML, ... they are all copied over by
default, including the sub-folders.
-You can change this behavior with the options:
-
-* `--skip-folders` : don't copy sub-folders from the input folder
-* `--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.
-| -
-|===
-
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/index.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/index.adoc
deleted file mode 100644
index db38a444ae..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/index.adoc
+++ /dev/null
@@ -1,23 +0,0 @@
-////
-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.
-////
-= Index Page
-
-* xref:getting-started.adoc[Getting started]
-* xref:docker-container.adoc[Docker container]
-* xref:hop-web-docker.adoc[Hop Web in Docker]
-* xref:hop-logo-and-icons.adoc[Hop logo and icons]
-* xref:hop-vs-kettle/index.adoc[Kettle/PDI and Hop]
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-architecture.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-architecture.adoc
deleted file mode 100644
index 0a264be078..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-architecture.adoc
+++ /dev/null
@@ -1,37 +0,0 @@
-////
-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: Apache Hop logging architecture and concepts.
-
-[[LoggingArchitecture-LoggingArchitecture]]
-= Logging
-
-== Introduction
-Apache Hop's logging architecture is mostly readable from our source code.
-In the following sections, we provide a general layout and concepts to get
familiar with.
-
-== HopLogStore
-The `HopLogStore.getInstance()` is where Channels are able to store and append
their logs.
-HopLogStore is initialized when you run `HopEnvironment.init()`
-
-== Channels
-Every runtime object (IPipelineEngine, IWorkflowEngine, etc.) in Apache Hop
has a log channel ID with which you can examine the HopLogStore for what was
logged for an ID.
-
-== Logging Registry
-The logging hierarchy is in `LoggingRegistry.getInstance()`
-
-== Log text
-To get logging text you can do something like:
`HopLogStore.getInstance().getAppender().getBuffer(pipeline.getLogChannelId(),
true);`
\ No newline at end of file
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-plugins.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-plugins.adoc
deleted file mode 100644
index 87d82e484b..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/logging/logging-plugins.adoc
+++ /dev/null
@@ -1,22 +0,0 @@
-////
-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: Apache Hop logging plugins architecture.
-
-= Introduction
-Apache Hop provides support for logging plugins.
-
-Example source code is available for a log4j plugin (somewhere - ask Matt).
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/logging/udjc-logging.adoc
b/docs/hop-tech-manual/modules/ROOT/pages/logging/udjc-logging.adoc
deleted file mode 100644
index 8d6b0163ff..0000000000
--- a/docs/hop-tech-manual/modules/ROOT/pages/logging/udjc-logging.adoc
+++ /dev/null
@@ -1,30 +0,0 @@
-////
-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: Apache Hop logging from UDJC.
-
-[[UDJCLogging-UDJCLogging]]
-= UDJC Logging
-
-== Introduction
-UDJC (User Defined Java Classes) allow for logging statements such as
`logBasic("test");`.
-
-The logs are stored in the following manner:
-
-- It goes to a Hop logging channel.
-- It ends up in `HopLogStore.getInstance()` which is initialized when you run
`HopEnvironment.init()`
-- The logging hierarchy is in `LoggingRegistry.getInstance()`
-- The logging text can be accessed with something like:
`HopLogStore.getInstance().getAppender().getBuffer(pipeline.getLogChannelId(),
true);`
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/import-dialog.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-import/import-dialog.png
similarity index 100%
rename from
docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/import-dialog.png
rename to
docs/hop-user-manual/modules/ROOT/assets/images/hop-import/import-dialog.png
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/import-report.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-import/import-report.png
similarity index 100%
rename from
docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/import-report.png
rename to
docs/hop-user-manual/modules/ROOT/assets/images/hop-import/import-report.png
diff --git
a/docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/menu-import.png
b/docs/hop-user-manual/modules/ROOT/assets/images/hop-import/menu-import.png
similarity index 100%
rename from
docs/hop-tech-manual/modules/ROOT/assets/images/hop-import/menu-import.png
rename to
docs/hop-user-manual/modules/ROOT/assets/images/hop-import/menu-import.png
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc
b/docs/hop-user-manual/modules/ROOT/nav.adoc
index d7bf2e5f44..3f0dc6f769 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -23,10 +23,17 @@ under the License.
** xref:getting-started/hop-gui-pipelines.adoc[Pipelines]
** xref:getting-started/hop-gui-workflows.adoc[Workflows]
** xref:getting-started/hop-next-steps.adoc[Next Steps]
+* xref:hop-vs-kettle/index.adoc[Kettle/PDI and Hop]
+** xref:hop-vs-kettle/hop-vs-kettle.adoc[Hop vs Kettle]
+** xref:hop-vs-kettle/if-you-know-kettle.adoc[If you know Kettle]
+** xref:hop-vs-kettle/import-kettle-projects.adoc[Upgrade Kettle to Hop]
* xref:concepts.adoc[Concepts]
* xref:installation-configuration.adoc[Installation and Configuration]
+* xref:docker-container.adoc[Hop in Docker]
+** xref:hop-web-docker.adoc[Hop Web in Docker]
* xref:supported-jvms.adoc[Supported Java Versions]
* xref:hop-gui/index.adoc[Hop Gui]
+** xref:hop-gui/disable-ui-elements.adoc[Customize the UI]
** xref:hop-gui/file-dialog.adoc[File Dialog]
** xref:hop-gui/hop-gui-popup-dialog.adoc[Popup Dialog]
** xref:hop-gui/notes.adoc[Notes on pipelines and workflows]
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/docker-container.adoc
b/docs/hop-user-manual/modules/ROOT/pages/docker-container.adoc
similarity index 97%
rename from docs/hop-tech-manual/modules/ROOT/pages/docker-container.adoc
rename to docs/hop-user-manual/modules/ROOT/pages/docker-container.adoc
index 067e9f4a8b..1674404533 100644
--- a/docs/hop-tech-manual/modules/ROOT/pages/docker-container.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/docker-container.adoc
@@ -287,7 +287,7 @@ That image will contain the last built Development snapshot
of Apache Hop. rxq77
The most common use case will be that you run a **short-lived container** to
just complete one Hop workflow or pipeline.
If CI already baked the project into the image, this is often all you need in
production: a scheduler starts the container, hop-run finishes, the container
exits -- no long-lived Hop Server.
-See
xref:manual::hop-server/deploy-project-image.adoc#skip_hop_server_short_lived_containers[Skip
Hop Server: short-lived containers].
+See
xref:hop-server/deploy-project-image.adoc#skip_hop_server_short_lived_containers[Skip
Hop Server: short-lived containers].
The first example below runs the sample `switch-case-basic.hpl` **pipeline**
from the samples project.
@@ -358,9 +358,9 @@ The value of `HOP_PARENT_PROJECT_NAME` should match
`parentProjectName` in the c
If you need a **long-lived container**, this option is also available.
-For more information on the long-lived container please also see the
xref:manual::hop-server/index.adoc[Hop Server] documentation as it describes
what can be done using the Hop Server.
+For more information on the long-lived container please also see the
xref:hop-server/index.adoc[Hop Server] documentation as it describes what can
be done using the Hop Server.
-To ship a git-hosted project *with* the image (CI builds `FROM apache/hop`,
copies the project to `/your-project`, then rolls the container) see
xref:manual::hop-server/deploy-project-image.adoc[Project in a Docker image].
+To ship a git-hosted project *with* the image (CI builds `FROM apache/hop`,
copies the project to `/your-project`, then rolls the container) see
xref:hop-server/deploy-project-image.adoc[Project in a Docker image].
Run this command to start a Hop Server in a docker container:
@@ -384,7 +384,7 @@ TIP: `localhost` is a loopback to your machine, which may
be the container but n
Hop Server is designed to receive all variables and metadata from executing
clients.
This means it needs little to no configuration to run.
-If you want to use the web-services functionality additional information on
how to configure your webserver can be found on the user manual
xref:manual::hop-server/web-service.adoc[Web Service] page. For this to work
properly the `HOP_SERVER_METADATA_FOLDER` variable has to be set too.
+If you want to use the web-services functionality additional information on
how to configure your webserver can be found on the user manual
xref:hop-server/web-service.adoc[Web Service] page. For this to work properly
the `HOP_SERVER_METADATA_FOLDER` variable has to be set too.
When started can then access the hop-server UI from your host at
`http://0.0.0.0:8181` or `http://localhost:8181`
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 06945b7523..698ff25ce1 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
@@ -398,7 +398,7 @@ include::../snippets/hop-tools/hop-import.adoc[]
+
-The example command below prints the `hop-import` help. Check the
xref:tech-manual::hop-vs-kettle/import-kettle-projects.adoc[] docs for more
information.
+The example command below prints the `hop-import` help. Check the
xref:hop-vs-kettle/import-kettle-projects.adoc[] docs for more information.
+
@@ -425,5 +425,5 @@ Linux, macOS::
====
-Read more at
xref:tech-manual::hop-vs-kettle/import-kettle-projects.adoc[Technical Manual ->
Hop vs Kettle -> Import Kettle Projects]
+Read more at xref:hop-vs-kettle/import-kettle-projects.adoc[Import Kettle
(PDI) projects]
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/disable-ui-elements.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/disable-ui-elements.adoc
similarity index 100%
rename from docs/hop-tech-manual/modules/ROOT/pages/disable-ui-elements.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/hop-gui/disable-ui-elements.adoc
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 8f614bba39..b103bb6459 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
@@ -122,7 +122,7 @@ Save real pipelines and workflows on the host or on a
volume, not under the imag
Set `HOP_CONFIG_FOLDER` and `HOP_AUDIT_FOLDER` to mounted paths so project
registrations, security files, and UI audit data survive `docker pull` of a new
`apache/hop-web` tag.
The official image already includes the standard plugin set; extra JDBC
drivers belong on a separate folder or `HOP_DRIVERS_DOWNLOAD`.
-The full persist/replace table, Compose example, and upgrade steps are in the
xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker] technical
documentation.
+The full persist/replace table, Compose example, and upgrade steps are in the
xref:hop-web-docker.adoc[Hop Web in Docker] page.
== Using the Hop CLI tools in Hop Web.
@@ -136,8 +136,8 @@ The tools are available in `/usr/local/tomcat/webapps/ROOT`
in a running Hop Web
Hop Web runs on a Tomcat server by default and ships with **no
authentication** (open access).
For any shared or production deployment you should put an authentication layer
in front of it.
-TIP: Persist `HOP_CONFIG_FOLDER/security/` (or the whole config folder) across
container upgrades so users, role mappings, and
xref:tech-manual::hop-web-docker.adoc[project access rules] are not lost.
-See xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker: persistence and
upgrades].
+TIP: Persist `HOP_CONFIG_FOLDER/security/` (or the whole config folder) across
container upgrades so users, role mappings, and
xref:hop-web-docker.adoc[project access rules] are not lost.
+See xref:hop-web-docker.adoc[Hop Web in Docker: persistence and upgrades].
There are two complementary layers:
@@ -360,7 +360,7 @@ docker run -it --rm -p 8080:8080 \
----
This volume keeps `users.json` only.
-To keep project registrations, GUI settings, and
xref:#hop-web-project-access[project access] rules as well, persist the whole
`HOP_CONFIG_FOLDER` as shown in xref:tech-manual::hop-web-docker.adoc[Hop Web
in Docker].
+To keep project registrations, GUI settings, and
xref:#hop-web-project-access[project access] rules as well, persist the whole
`HOP_CONFIG_FOLDER` as shown in xref:hop-web-docker.adoc[Hop Web in Docker].
Or from a local source build:
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 178ee81603..e1bdd41f1e 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
@@ -38,4 +38,4 @@ Covered here are:
* xref:hop-gui/hop-gui-git.adoc[Working with git]: Manage files in the git
version control system
* xref:hop-gui/shortcuts.adoc[Keyboard Shortcuts]: a list of the keyboard
shortcuts that are available in Hop Gui.
* xref:hop-gui/hop-web.adoc[Hop Web]: a web version of Hop Gui that provides
the exact same functionality and user experience as the desktop version.
-For Docker volume mounts and upgrades, see
xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker].
+For Docker volume mounts and upgrades, see xref:hop-web-docker.adoc[Hop Web in
Docker].
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-git-checkout.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-git-checkout.adoc
index e8640145e4..2e6792c4b6 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-git-checkout.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-git-checkout.adoc
@@ -96,7 +96,7 @@ docker run -d --name hop-server \
`git pull` on the host updates the files the container sees.
Restart the container after you change environment JSON or `hop-server.xml`.
-The
xref:tech-manual::docker-container.adoc#_custom_entrypoint_extension_shell_script[custom
entrypoint] example on the Docker page shows how to `git clone` (or `git
pull`) inside the container at start if the host itself should not hold the
clone.
+The
xref:docker-container.adoc#_custom_entrypoint_extension_shell_script[custom
entrypoint] example on the Docker page shows how to `git clone` (or `git pull`)
inside the container at start if the host itself should not hold the clone.
== Updating
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-project-image.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-project-image.adoc
index 751f5a5f3f..3e7b575045 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-project-image.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/deploy-project-image.adoc
@@ -63,7 +63,7 @@ When you set the variables below it:
. otherwise starts Hop Server with the environment enabled
You do not need a custom `CMD`.
-The xref:tech-manual::docker-container.adoc[Docker container] page lists every
variable.
+The xref:docker-container.adoc[Docker container] page lists every variable.
[cols="2,3",options="header"]
|===
@@ -296,4 +296,4 @@ Export resources is optional here: the server already has
the project.
Prefer executing a filename under `{openvar}PROJECT_HOME{closevar}` that
exists in the image.
For the short-lived alternative, see
<<skip_hop_server_short_lived_containers>>.
-The xref:tech-manual::docker-container.adoc[Docker container] page lists every
hop-run variable. The
xref:how-to-guides/apache-hop-web-services-docker.adoc[web services in Docker]
how-to is the long-lived case.
+The xref:docker-container.adoc[Docker container] page lists every hop-run
variable. The xref:how-to-guides/apache-hop-web-services-docker.adoc[web
services in Docker] how-to is the long-lived case.
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 b182275f0b..87ae417406 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
@@ -483,7 +483,7 @@ If applied correctly, your Hop Server starts producing _a
lot_ of logging inform
=== Start Hop Server with docker
It's often very convenient to run a Hop docker container since it has all the
required software automatically delivered.
-For a complete description of the standard Hop docker container see the
https://hop.apache.org/tech-manual/latest/docker-container.html[full reference]
in the technical documentation.
+For a complete description of the standard Hop docker container see the
xref:docker-container.adoc[Hop in Docker] page.
Here is an example of how you would start a "long-lived" docker container:
[source,bash]
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 c8cde8377b..80dd415131 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
@@ -14,12 +14,17 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
+:openvar: ${
+:closevar: }
:description: Hop Import is a command line tool for importing and convert
third party metadata to an Apache Hop format.
= Hop Import
Hop Import is a command line tool to import and convert third party metadata
to an Apache Hop format.
+The same import runs from the Hop GUI through `File / Import from Kettle/PDI`.
+See xref:hop-vs-kettle/import-kettle-projects.adoc[Import Kettle (PDI)
projects] for that walkthrough and the options in the import dialog.
+
== Usage
Usage help can be obtained by running hop-import with the `-h` option, even
when other options are specified:
@@ -133,3 +138,46 @@ Creating new default Hop configuration file:
s3:///apache-hop/s3project/imported
2021/06/22 16:39:43 - HopImport - Connections with the same name and different
configurations have only been saved once.
2021/06/22 16:39:43 - HopImport - Check the following file for a list of
connections that might need extra attention:
s3:///apache-hop/s3project/connections.csv
----
+
+== Functionality
+
+In general the plugin copies Kettle files and non-Kettle files.
+
+=== Kettle files
+
+|===
+|File |Conversion
+
+|Transformations
+|Kettle transformation files (.ktr extension) are converted to Hop pipelines.
+During this process the XML metadata is converted to the appropriate Hop
format.
+
+|Jobs
+|Kettle job files (.kjb extension) are converted to Hop workflows.
+During this process the XML metadata is converted to the appropriate Hop
format.
+
+|kettle.properties
+|The Kettle properties file in your .kettle folder (typically found in the
home directory or `{openvar}KETTLE_HOME{closevar}`) often contains variables
and values regarding your environment.
+These variables and values are converted into an environment configuration
file if you specified the `-c` or `--target-config-file` option.
+When you create an environment in Hop you can simply add this file to it to
make everything work.
+If the configuration file already exists it will be updated, not overwritten.
+The description of the newly imported variables is set to `Imported from
Kettle` to indicate that it's new.
+Values of existing variables are overwritten and the existing description is
kept.
+
+|shared.xml
+|The shared.xml file in your .kettle folder (typically found in the home
directory or `{openvar}KETTLE_HOME{closevar}`) often contains connections which
are shared across many transformations and jobs.
+These connections are imported as Relational Database Connection metadata
stored in the target folder `metadata/rdbms` folder.
+
+|jdbc.properties
+|A jdbc.properties file sometimes contains relational database metadata which
is converted into generic RDBMS connections metadata.
+|===
+
+=== Non-Kettle files
+
+Non-Kettle files like text files, JSON, XML, ... they are all copied over by
default, including the sub-folders.
+You can change this behavior with the options:
+
+* `--skip-folders` : don't copy sub-folders from the input folder
+* `--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
+
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
similarity index 100%
rename from
docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/hop-vs-kettle.adoc
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
similarity index 93%
rename from
docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
index 057c96bb15..e5966c0ae0 100644
---
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/if-you-know-kettle.adoc
@@ -42,7 +42,7 @@ A couple of things have been renamed to align Apache Hop with
modern data proces
|Kettle|Hop|Difference
|Spoon|Hop Gui|Spoon has been abandoned.
Hop Gui was written from scratch.
-Check the xref:manual::getting-started/index.adoc[Getting Started guide] or
the xref:manual::hop-gui/index.adoc[Hop Gui docs] to find out more.
+Check the xref:getting-started/index.adoc[Getting Started guide] or the
xref:hop-gui/index.adoc[Hop Gui docs] to find out more.
|Transformation|Pipeline|No conceptual changes.
You'll develop pipelines just like you would develop a transformation, but a
pipeline in Hop can run on different runtimes
|Job|Workflow|No conceptual changes.
@@ -56,18 +56,18 @@ This happens behind the scenes.
Except for increased usability, as a Hop developer, you'll hardly notice.
|Carte|Hop Server|Again, smooth sailing.
A lot has changed behind the scenes, but you'll hardly notice.
-Check the xref:manual::hop-server/index.adoc[docs]
+Check the xref:hop-server/index.adoc[docs]
|Pan/Kitchen/(Maitre)|Hop Run|Kitchen and Pan depended on the Spoon GUI code.
With the rewrite of Spoon to Hop Gui, we've recreated the command line tools.
We believe this now is more consistent while providing more options and being
easier to use at the same time.
-Check the xref:manual::hop-run/index.adoc[docs]
+Check the xref:hop-run/index.adoc[docs]
|JNDI|gone|jndi in Kettle/PDI is based on an open source project that hasn't
been updated in about a decade.
As there was no reason to keep this functionality in Hop, it was abandoned.
|Repositories|gone|Code repositories belong in a VCS these days.
We've abandoned the file and database (and PDI EE repositories) repositories,
but implemented Git integration instead.
|-|Projects, Environments, Run Config|The
https://github.com/mattcasters/kettle-environment[Kettle Environments Plugin]
has been integrated and significantly extended.
Hop now has integrated functionality to support your projects, environments
and run configurations.
-Check the xref:manual::projects/projects-environments.adoc[docs].
+Check the xref:projects/projects-environments.adoc[docs].
|-|Hop Config|This is a new command line tool to configure your projects,
environments and run configurations.
|===
diff --git
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
similarity index 80%
rename from
docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
index 4ce3669447..4ffa436011 100644
---
a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/import-kettle-projects.adoc
@@ -57,18 +57,25 @@ The options in this dialog are:
[options="header",width=90%]
|===
-|Option|Description|Optional
-|Import From|The folder to import Kettle/PDI jobs and transformations from|No
-|Import in existing project|check to import into an existing project, uncheck
to import into a folder|No
-|Import in project|Dropdown list of available projects to import the
Kettle/PDI project into|Conditional
+|Option|Description|Default
+|Import from|The folder to import Kettle/PDI jobs and transformations from|-
+|Import in existing project|Check to import into an existing project, uncheck
to import into a folder|Selected
+|Import in project|Dropdown list of available projects to import the
Kettle/PDI project into|-
|Import to folder|Path to import the Kettle/PDI project to.
-All imported items will be imported into a Hop project in this
folder.|Conditional
+All imported items will be imported into a Hop project in this folder.
+Only available when *Import in existing project* is unchecked.|-
|Path to kettle.properties|Path to a kettle.properties file.
-All properties in this file will be imported as variables in the Hop
project.|Yes
+All properties in this file will be imported as variables in the Hop project.|-
|Path to shared.xml|Path to a shared.xml file.
-All database connections in this file will be imported as Hop relational
database connection metadata objects in the specified Hop project or folder.|Yes
+All database connections in this file will be imported as Hop relational
database connection metadata objects in the specified Hop project or folder.|-
|Path to jdbc.properties|Path to a jdbc.properties file.
-All Kettle/PDI JNDI database connections in this file will be imported as Hop
(generic) relational database connection metadata objects in the specified Hop
project or folder.|Yes
+All Kettle/PDI JNDI database connections in this file will be imported as Hop
(generic) relational database connection metadata objects in the specified Hop
project or folder.|-
+|Skip existing target files?|Skip files that are already present in the target
folder|Selected
+|Skip hidden files and folders?|Exclude hidden files and folders such as
`.git` and `.gitignore` from the import|Selected
+|Skip folders in the source?|Exclude the sub-folders of the source folder from
the import|Selected
+|Target environment variables config file|Name of the environment
configuration file the variables from `kettle.properties` are written
to|`imported-env-conf.json`
+|Pipeline default run configuration|The run configuration set as the default
on imported pipelines|-
+|Workflow default run configuration|The run configuration set as the default
on imported workflows|-
|===
After entering your import details, click the 'Import' button.
@@ -96,4 +103,4 @@ This file contains a list of all jobs and transformations,
with the connections
The `hop-import.sh/bat` CLI tool lets you import Kettle/PDI projects from the
command line.
-Check the xref:hop-vs-kettle/hop-import.adoc[hop-import] page for details.
+Check the xref:hop-tools/hop-import.adoc[hop-import] page for details.
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/index.adoc
similarity index 100%
rename from docs/hop-tech-manual/modules/ROOT/pages/hop-vs-kettle/index.adoc
rename to docs/hop-user-manual/modules/ROOT/pages/hop-vs-kettle/index.adoc
diff --git a/docs/hop-tech-manual/modules/ROOT/pages/hop-web-docker.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-web-docker.adoc
similarity index 89%
rename from docs/hop-tech-manual/modules/ROOT/pages/hop-web-docker.adoc
rename to docs/hop-user-manual/modules/ROOT/pages/hop-web-docker.adoc
index 7513a5e3aa..4421ab5d59 100644
--- a/docs/hop-tech-manual/modules/ROOT/pages/hop-web-docker.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-web-docker.adoc
@@ -33,7 +33,7 @@ This page answers how to run that image in an
upgrade-friendly way:
* how to add **JDBC drivers** (and why you should not persist `plugins/`)
* which **volume mounts** to use, with a small Compose example
-The xref:manual::hop-gui/hop-web.adoc[Hop Web user manual] covers starting the
image, authentication modes, and the Security UI.
+The xref:hop-gui/hop-web.adoc[Hop Web user manual] covers starting the image,
authentication modes, and the Security UI.
The xref:docker-container.adoc[Docker container] page covers the sibling
`apache/hop` image (hop-run and Hop Server).
== Two images, two persistence models
@@ -50,7 +50,7 @@ The baked-in `default` and `samples` projects are only a
starter layout.
| `apache/hop`
| hop-run (short-lived) or Hop Server (long-lived)
| Often **in a derived image** for production execution.
-That is xref:manual::hop-server/deploy-project-image.adoc[Project in a Docker
image], not a Hop Web upgrade procedure.
+That is xref:hop-server/deploy-project-image.adoc[Project in a Docker image],
not a Hop Web upgrade procedure.
|===
Do not `docker commit` a Hop Web container that has work saved in it, and do
not treat the image's own `config/projects/` tree as your project home.
@@ -110,7 +110,7 @@ Recommended container paths below are conventions for this
page and the Compose
| Environment JSON
| none
| `/hop/config/environments/` or next to the project when the file is
non-secret
-| Hostnames, paths,
xref:manual::metadata-types/variable-resolver/index.adoc[resolvers].
+| Hostnames, paths,
xref:metadata-types/variable-resolver/index.adoc[resolvers].
Keep secrets out of git.
| `{openvar}HOP_AUDIT_FOLDER{closevar}`
@@ -162,7 +162,7 @@ Use together with a mount at `HOP_PROJECT_FOLDER`.
| `HOP_PARENT_PROJECT_NAME` / `HOP_PARENT_PROJECT_FOLDER`
| Optional one-level parent project.
-See xref:manual::hop-gui/hop-web.adoc[Hop Web].
+See xref:hop-gui/hop-web.adoc[Hop Web].
| `HOP_ENVIRONMENT_NAME` / `HOP_ENVIRONMENT_CONFIG_FILE_NAME_PATHS`
| Optional lifecycle environment registered on start.
@@ -178,7 +178,7 @@ See
xref:docker-container.adoc#DownloadingJDBCDrivers[Downloading JDBC drivers].
| `HOP_WEB_SECURITY_MODE` and related `HOP_WEB_*` variables
| Authentication bootstrap.
-See xref:manual::hop-gui/hop-web.adoc#hop-web-authentication[Hop Web
authentication].
+See xref:hop-gui/hop-web.adoc#hop-web-authentication[Hop Web authentication].
|===
.Permissions
@@ -191,7 +191,7 @@ Named volumes created by Docker usually already are.
* Mount an **empty** directory onto the *default* config path
(`/usr/local/tomcat/webapps/ROOT/config`) unless you intend to hide the image
`hop-config.json` and the starter projects.
Prefer a separate path (`/hop/config`) so the image tree stays available for
reference.
* Use the `/config` mount (Tomcat `tomcat-users.xml` / `web.xml` overlay) for
environment JSON or project files.
-That path is only for
xref:manual::hop-gui/hop-web.adoc#hop-web-authentication[EXTERNAL] container
authentication.
+That path is only for
xref:hop-gui/hop-web.adoc#hop-web-authentication[EXTERNAL] container
authentication.
[[JDBCDriversAndPlugins]]
== JDBC drivers and plugins
@@ -203,7 +203,7 @@ A new image tag is how you pick up plugin fixes and
additions.
Do not persist `plugins/` on a volume: an old tree mixed with a new image is a
common upgrade failure.
-Custom or xref:manual::hop-tools/hop-marketplace.adoc[marketplace] extras that
are not in the image can be:
+Custom or xref:hop-tools/hop-marketplace.adoc[marketplace] extras that are not
in the image can be:
* installed in a small derived image (`FROM apache/hop-web`, then `hop
marketplace apply` or `COPY` the plugin), or
* re-applied after you recreate the container (`hop marketplace apply -f …` in
the new container).
@@ -234,7 +234,7 @@ Keep the image's `/usr/local/tomcat/jdbc-drivers` on that
list so bundled driver
From Hop 2.20, Hop Web can authenticate users and map them to built-in roles
(Admin, User, Operator, Read-only), and the Projects plugin can **restrict
which projects a user may open**.
-Full behaviour, login modes (`NONE`, `EXTERNAL`, `BASIC`, `OAUTH2`), and the
Security UI are documented in
xref:manual::hop-gui/hop-web.adoc#hop-web-authentication[Hop Web
authentication].
+Full behaviour, login modes (`NONE`, `EXTERNAL`, `BASIC`, `OAUTH2`), and the
Security UI are documented in
xref:hop-gui/hop-web.adoc#hop-web-authentication[Hop Web authentication].
For upgrades, the important fact is **where those files live**.
All of the following sit under
`{openvar}HOP_CONFIG_FOLDER{closevar}/security/`:
@@ -255,7 +255,7 @@ All of the following sit under
`{openvar}HOP_CONFIG_FOLDER{closevar}/security/`:
Persist `{openvar}HOP_CONFIG_FOLDER{closevar}` and you keep project
registrations, users, and “who may open which project” across image upgrades.
-Configure project mapping in the GUI: **Configuration → Security → Projects**
(xref:manual::hop-gui/hop-web.adoc#hop-web-project-access[project access]).
+Configure project mapping in the GUI: **Configuration → Security → Projects**
(xref:hop-gui/hop-web.adoc#hop-web-project-access[project access]).
Enable filtering, add rules (`user` / `role` / `group`), and either allow all
projects for that subject or list names.
Security administrators (`security.manage`) always see every project.
When no rule matches, `defaultAllowAll` decides whether the user sees all
projects or none.
@@ -324,7 +324,7 @@ Replace `<tag>` with a released Hop version.
Create `./projects/my-project` (with `project-config.json`) on the host before
the first start, and ensure it is writable by UID 501.
Set `HOP_WEB_ADMIN_PASSWORD` in the environment or a Compose `.env` file; do
not commit it.
-For OAuth or Tomcat EXTERNAL authentication, keep this volume layout and
follow xref:manual::hop-gui/hop-web.adoc#hop-web-authentication[Hop Web
authentication] for the extra settings.
+For OAuth or Tomcat EXTERNAL authentication, keep this volume layout and
follow xref:hop-gui/hop-web.adoc#hop-web-authentication[Hop Web authentication]
for the extra settings.
If you use EXTERNAL, mount `tomcat-users.xml` and `web.xml` at `/config/` and
do not put project files there.
== Upgrade procedure
@@ -342,8 +342,8 @@ If you added marketplace plugins that are not in the new
image, re-apply the ins
== See also
-* xref:manual::hop-gui/hop-web.adoc[Hop Web] — start the image, roles, BASIC /
OAuth / EXTERNAL
+* xref:hop-gui/hop-web.adoc[Hop Web] — start the image, roles, BASIC / OAuth /
EXTERNAL
* xref:docker-container.adoc[Docker container] — `apache/hop` (hop-run and Hop
Server)
-* xref:manual::installation-configuration.adoc[Installation and configuration]
— desktop `HOP_CONFIG_FOLDER` (same idea, no container)
-* xref:manual::projects/index.adoc[Projects and environments]
-* xref:manual::hop-server/deploy-project-image.adoc[Project in a Docker image]
— baking a project into `apache/hop` for execution
+* xref:installation-configuration.adoc[Installation and configuration] —
desktop `HOP_CONFIG_FOLDER` (same idea, no container)
+* xref:projects/index.adoc[Projects and environments]
+* xref:hop-server/deploy-project-image.adoc[Project in a Docker image] —
baking a project into `apache/hop` for execution
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/apache-hop-web-services-docker.adoc
b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/apache-hop-web-services-docker.adoc
index 989ece5595..3e4b786b95 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/apache-hop-web-services-docker.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/apache-hop-web-services-docker.adoc
@@ -129,7 +129,7 @@ To execute the containers afterwards, the following
environment variables or par
|Name||Name of the Docker container
|===
-In the technical documentation for Apache HOP running as Docker Container (pls
see https://hop.apache.org/tech-manual/latest/docker-container.html[docs]),
further parameters are listed (e.g. when using SSL), which have been omitted
here for simplification.
+On the xref:docker-container.adoc[Hop in Docker] page, further parameters are
listed (e.g. when using SSL), which have been omitted here for simplification.
Example call:
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/run-hop-in-apache-airflow.adoc
b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/run-hop-in-apache-airflow.adoc
index 769649fa64..a0d3ce115b 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/run-hop-in-apache-airflow.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/how-to-guides/run-hop-in-apache-airflow.adoc
@@ -89,7 +89,7 @@ To have Airflow submit work to a running Hop Server instead
(remote run configur
We'll use the Apache Airflow
https://airflow.apache.org/docs/apache-airflow-providers-docker/stable/_api/airflow/providers/docker/operators/docker/index.html[DockerOperator^]
to run Apache Hop workflows and pipelines from an embedded container in Apache
Airflow.
Again, you don't need to be an Apache Airflow, Docker, or Python expert to
create DAGs, we'll treat DAGs as just another text file.
-Since we'll use a container to run our workflows and pipelines, the
configuration in our DAG will look very similar to the environment variables
you'll pass to the xref:tech-manual::docker-container.adoc[short-lived Apache
Hop container].
+Since we'll use a container to run our workflows and pipelines, the
configuration in our DAG will look very similar to the environment variables
you'll pass to the xref:docker-container.adoc[short-lived Apache Hop
container].
Let's take a closer look at a couple of things in the DAG we'll use. This will
look very familiar if you've even run Apache Hop workflows and pipelines in
containers:
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
b/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
index 79aef31148..37f6549441 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/installation-configuration.adoc
@@ -28,7 +28,7 @@ This page covers everything you need to know to install and
run Apache Hop on yo
Hop is designed to be as flexible and lightweight as possible, and is intended
to blend in with your architecture, not the other way around. This makes the
basic installation process extremely easy, but there's a lot of configuration
that can be applied to make Hop behave exactly the way you want it to.
-TIP: Take a look at the xref:tech-manual::docker-container.adoc[Docker] page
for `apache/hop` (hop-run and Hop Server), and
xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker] for persisting
projects and config across image upgrades.
+TIP: Take a look at the xref:docker-container.adoc[Docker] page for
`apache/hop` (hop-run and Hop Server), and xref:hop-web-docker.adoc[Hop Web in
Docker] for persisting projects and config across image upgrades.
== System Requirements
@@ -132,7 +132,7 @@ With the environment variables described in the previous
section, all you need t
TIP: Apache Hop releases are tested for smooth upgrades. You can replace your
existing installation when a new version is released. If you want to keep
multiple Apache Hop versions around, consider renaming your unzipped `hop`
folder to `hop-version-number`, e.g. `hop-2.5.0`, `hop-2.60` etc.
-TIP: For Hop Web in Docker, persist `HOP_CONFIG_FOLDER` and project homes on
volumes and replace the image. See xref:tech-manual::hop-web-docker.adoc[Hop
Web in Docker: persistence and upgrades].
+TIP: For Hop Web in Docker, persist `HOP_CONFIG_FOLDER` and project homes on
volumes and replace the image. See xref:hop-web-docker.adoc[Hop Web in Docker:
persistence and upgrades].
== Additional configuration
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 f844bc1dcf..55a6165a44 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/projects/index.adoc
@@ -47,7 +47,7 @@ TIP: project variables should only be used when you need
variables on the projec
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.
-TIP: In Hop Web Docker, keep *project homes* on a host folder or volume as
well. The image's `default` and `samples` projects are only a starter layout.
See xref:tech-manual::hop-web-docker.adoc[Hop Web in Docker: persistence and
upgrades].
+TIP: In Hop Web Docker, keep *project homes* on a host folder or volume as
well. The image's `default` and `samples` projects are only a starter layout.
See xref:hop-web-docker.adoc[Hop Web in Docker: persistence and upgrades].
Projects can inherit metadata and variables from a parent project.
