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 073f44118f fix documentation issues. fixes #7094 (#7096)
073f44118f is described below
commit 073f44118f6802112ad2e9bc2cb7c8a073ccbc89
Author: Bart Maertens <[email protected]>
AuthorDate: Tue May 5 12:23:57 2026 +0000
fix documentation issues. fixes #7094 (#7096)
---
docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc | 4 ++--
docs/hop-user-manual/modules/ROOT/nav.adoc | 2 ++
.../modules/ROOT/pages/hop-server/rest-api.adoc | 14 ++++++++------
.../modules/ROOT/pages/metadata-types/rest-connection.adoc | 4 +++-
.../ROOT/pages/pipeline/transforms/data-stream-input.adoc | 2 +-
.../ROOT/pages/pipeline/transforms/data-stream-output.adoc | 4 ++--
.../ROOT/pages/pipeline/transforms/dbimpactinput.adoc | 4 +++-
.../modules/ROOT/pages/technology/neo4j/index.adoc | 2 +-
8 files changed, 22 insertions(+), 14 deletions(-)
diff --git a/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
index 8b63c2d4dc..2174dff2bb 100644
--- a/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/pages/hopweb/index.adoc
@@ -143,11 +143,11 @@ If you want to run Hop Web with the `default` and
`samples` projects, make sure
On Linux, use the following sed command to fix this in one line:
-`sed -i 's/config\/projects/{openvar}HOP_CONFIG_FOLDER{closevar}\/projects/g'
${CATALINA_HOME}/webapps/ROOT/config/hop-config.json`
+`sed -i 's/config\/projects/{openvar}HOP_CONFIG_FOLDER{closevar}\/projects/g'
{openvar}CATALINA_HOME{closevar}/webapps/ROOT/config/hop-config.json`
On macOS, use (note the empty string '' after -i):
-`sed -i ''
's/config\/projects/{openvar}HOP_CONFIG_FOLDER{closevar}\/projects/g'
${CATALINA_HOME}/webapps/ROOT/config/hop-config.json`
+`sed -i ''
's/config\/projects/{openvar}HOP_CONFIG_FOLDER{closevar}\/projects/g'
{openvar}CATALINA_HOME{closevar}/webapps/ROOT/config/hop-config.json`
On Windows, modify `hop-config.json` to make sure `projectsConf` looks like
the one below:
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc
b/docs/hop-user-manual/modules/ROOT/nav.adoc
index 90da4a2b7c..40fedf4405 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -112,6 +112,8 @@ under the License.
*** xref:pipeline/transforms/copyrowstoresult.adoc[Copy rows to result]
*** xref:pipeline/transforms/creditcardvalidator.adoc[Credit card validator]
*** xref:pipeline/transforms/csvinput.adoc[CSV File Input]
+*** xref:pipeline/transforms/data-stream-input.adoc[Data Stream Input]
+*** xref:pipeline/transforms/data-stream-output.adoc[Data Stream Output]
*** xref:pipeline/transforms/databasejoin.adoc[Database Join]
*** xref:pipeline/transforms/databaselookup.adoc[Database Lookup]
*** xref:pipeline/transforms/datagrid.adoc[Data Grid]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-server/rest-api.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-server/rest-api.adoc
index 72c5b658e8..f1363b169e 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-server/rest-api.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-server/rest-api.adoc
@@ -15,6 +15,8 @@ specific language governing permissions and limitations
under the License.
////
[[HopServerRestApi]]
+:openvar: ${
+:closevar: }
:imagesdir: ../assets/images
:description: Hop Server has a rich set of web services that can be used to
query and manage the server's status, or to manage pipeline and workflow
execution details.
@@ -790,13 +792,13 @@ execPipeline
description::
Execute a pipeline directly from a file path on the server's file system.
The pipeline is loaded, executed synchronously, and the result is returned
immediately.
-This servlet supports variable resolution in file paths (e.g.,
`${PROJECT_HOME}`) and can pass parameters and variables to the pipeline.
+This servlet supports variable resolution in file paths (e.g.,
`{openvar}PROJECT_HOME{closevar}`) and can pass parameters and variables to the
pipeline.
endPoint::
GET `/hop/execPipeline`
parameters::
-* pipeline (required): File path to the pipeline (.hpl file). Can use
variables like `${PROJECT_HOME}` which will be resolved by the server.
+* pipeline (required): File path to the pipeline (.hpl file). Can use
variables like `{openvar}PROJECT_HOME{closevar}` which will be resolved by the
server.
* level (optional): Logging level (e.g., Debug, Basic, Detailed, Error,
Minimal, Nothing, RowLevel). Defaults to server's default log level.
* runConfig (optional): Run configuration name to use for execution. If not
specified, the default run configuration from metadata is used, or "local" if
no default is found.
* *any parameter name*: Any additional URL parameters will be passed as
pipeline parameters or variables. If the parameter name matches a pipeline
parameter, it will be set as a parameter; otherwise, it will be set as a
variable.
@@ -854,7 +856,7 @@ Error response - Execution error (HTTP 500):
----
notes::
-* The pipeline path supports variable resolution. If the server is started
with a project (using `-j` flag), variables like `${PROJECT_HOME}` will be
resolved.
+* The pipeline path supports variable resolution. If the server is started
with a project (using `-j` flag), variables like
`{openvar}PROJECT_HOME{closevar}` will be resolved.
* The execution is synchronous - the servlet waits for the pipeline to
complete before returning.
* The pipeline is automatically registered in the server's pipeline map and
can be queried using `getPipelineStatus`.
* All URL parameters except `pipeline`, `level`, and `runConfig` are passed to
the pipeline as parameters or variables.
@@ -867,13 +869,13 @@ execWorkflow
description::
Execute a workflow directly from a file path on the server's file system.
The workflow is loaded, executed synchronously, and the result is returned
immediately.
-This servlet supports variable resolution in file paths (e.g.,
`${PROJECT_HOME}`) and can pass parameters and variables to the workflow.
+This servlet supports variable resolution in file paths (e.g.,
`{openvar}PROJECT_HOME{closevar}`) and can pass parameters and variables to the
workflow.
endPoint::
GET `/hop/execWorkflow`
parameters::
-* workflow (required): File path to the workflow (.hwf file). Can use
variables like `${PROJECT_HOME}` which will be resolved by the server.
+* workflow (required): File path to the workflow (.hwf file). Can use
variables like `{openvar}PROJECT_HOME{closevar}` which will be resolved by the
server.
* level (optional): Logging level (e.g., Debug, Basic, Detailed, Error,
Minimal, Nothing, RowLevel). Defaults to server's default log level.
* runConfig (optional): Run configuration name to use for execution. If not
specified, the default run configuration from metadata is used, or "local" if
no default is found.
* *any parameter name*: Any additional URL parameters will be passed as
workflow parameters or variables. If the parameter name matches a workflow
parameter, it will be set as a parameter; otherwise, it will be set as a
variable.
@@ -931,7 +933,7 @@ Error response - Execution error (HTTP 500):
----
notes::
-* The workflow path supports variable resolution. If the server is started
with a project (using `-j` flag), variables like `${PROJECT_HOME}` will be
resolved.
+* The workflow path supports variable resolution. If the server is started
with a project (using `-j` flag), variables like
`{openvar}PROJECT_HOME{closevar}` will be resolved.
* The execution is synchronous - the servlet waits for the workflow to
complete before returning.
* The workflow is automatically registered in the server's workflow map and
can be queried using `getWorkflowStatus`.
* All URL parameters except `workflow`, `level`, and `runConfig` are passed to
the workflow as parameters or variables.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/rest-connection.adoc
b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/rest-connection.adoc
index 6444ccd30a..9e042e0696 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/rest-connection.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/rest-connection.adoc
@@ -14,6 +14,8 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
+:openvar: ${
+:closevar: }
:page-pagination:
:description:
@@ -40,7 +42,7 @@ xref:pipeline/transforms/rest.adoc[REST client]
|Authentication type|Select how Hop should authenticate when this metadata is
used. The available choices are described below.
|===
-Use environment variables or Hop variables (for example `${PROJECT_HOME}`) in
any text box. The connection resolves variables when the metadata is loaded, so
the same definition can be reused from pipelines, workflows, and the Hop GUI
test button.
+Use environment variables or Hop variables (for example
`{openvar}PROJECT_HOME{closevar}`) in any text box. The connection resolves
variables when the metadata is loaded, so the same definition can be reused
from pipelines, workflows, and the Hop GUI test button.
== Authentication
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-input.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-input.adoc
index 6aa6854546..b6a291b3b0 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-input.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-input.adoc
@@ -33,7 +33,7 @@ It supports all available Data Stream implementations (Arrow
File Stream, Arrow
| Option | Description
| *Data Stream* |
-The name of the source xref:../../metadata/data-stream.adoc[Data Stream] to
read from.
+The name of the source xref:/metadata-types/data-stream/data-stream.adoc[Data
Stream] to read from.
This is a dropdown that shows all defined Data Streams in the project.
|===
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-output.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-output.adoc
index 0a62aa1e43..aec06edefa 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-output.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/data-stream-output.adoc
@@ -22,7 +22,7 @@ under the License.
== Overview
-The **Data Stream Output** transform writes rows from a Hop pipeline to a
configured xref:metadata-types/data-stream/data-stream.adoc[Data Stream].
+The **Data Stream Output** transform writes rows from a Hop pipeline to a
configured xref:/metadata-types/data-stream/data-stream.adoc[Data Stream].
It supports all available Data Stream implementations (Arrow File Stream,
Arrow Random Access File, and Arrow Flight).
@@ -33,7 +33,7 @@ It supports all available Data Stream implementations (Arrow
File Stream, Arrow
| Option | Description
| *Data Stream* |
-The name of the target xref:../../metadata/data-stream.adoc[Data Stream] to
write to.
+The name of the target xref:/metadata-types/data-stream/data-stream.adoc[Data
Stream] to write to.
This is a dropdown that shows all defined Data Streams in the project.
|===
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dbimpactinput.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dbimpactinput.adoc
index ef435cbb1e..dc5ba55ec5 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dbimpactinput.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/dbimpactinput.adoc
@@ -17,6 +17,8 @@ under the License.
:documentationPath: /pipeline/transforms/
:language: en_US
:description: Read database impact information from pipelines.
+:openvar: ${
+:closevar: }
= image:images/icons/database.svg[Database Impact Input,
role="image-doc-icon"] Database Impact Input
@@ -55,7 +57,7 @@ This name has to be unique in a single pipeline.
|===
-TIP: You can use a xref:pipeline/transforms/getfilenames.adoc[Get File Names]
transform as input. To search for your project pipelines specify folder
`${PROJECT_HOME}` with wildcard `.*\.hpl$`.
+TIP: You can use a xref:pipeline/transforms/getfilenames.adoc[Get File Names]
transform as input. To search for your project pipelines specify folder
`{openvar}PROJECT_HOME{closevar}` with wildcard `.*\.hpl$`.
== Output fields
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/technology/neo4j/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/technology/neo4j/index.adoc
index 5319316205..2dd891c876 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/technology/neo4j/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/technology/neo4j/index.adoc
@@ -43,7 +43,7 @@ The path you get is the exact path that was followed from for
example the "grand
== Metadata Types
* xref:metadata-types/neo4j/neo4j-connection.adoc[Neo4j Connection]: create or
manage a connection to a Neo4j database
-* xref:metadata-types/neo4j/neo4j-graphmodel.adoc[Neo4j Graph Model]: crearte
or manage a Neo4j (sub)graph model
+* xref:metadata-types/neo4j/neo4j-graphmodel.adoc[Neo4j Graph Model]: create
or manage a Neo4j (sub)graph model
== Workflow Actions
