This is an automated email from the ASF dual-hosted git repository.
bamaer 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 62f2751dd7 Fill empty and copied page descriptions, move the
Salesforce fragments to snippets, remove a duplicate heading, fail the
description check on empty descriptions. #8976 (#8991)
62f2751dd7 is described below
commit 62f2751dd7cd79f41409c0d60e6632c5f76dadf5
Author: Adalennis <[email protected]>
AuthorDate: Mon Oct 19 08:05:52 2026 +0200
Fill empty and copied page descriptions, move the Salesforce fragments to
snippets, remove a duplicate heading, fail the description check on empty
descriptions. #8976 (#8991)
---
.github/workflows/pr_build_docs.yml | 8 ++++----
.../ROOT/pages/hop-gui/perspective-execution-information.adoc | 2 +-
.../ROOT/pages/metadata-types/mail-server-connection.adoc | 2 +-
.../modules/ROOT/pages/metadata-types/rest-connection.adoc | 2 +-
.../ROOT/pages/pipeline/transforms/pipeline-data-probe.adoc | 2 +-
.../modules/ROOT/pages/pipeline/transforms/salesforcedelete.adoc | 4 ++--
.../modules/ROOT/pages/pipeline/transforms/salesforceinput.adoc | 2 +-
.../modules/ROOT/pages/pipeline/transforms/salesforceinsert.adoc | 6 +++---
.../modules/ROOT/pages/pipeline/transforms/salesforceupdate.adoc | 9 +++------
.../modules/ROOT/pages/pipeline/transforms/salesforceupsert.adoc | 6 +++---
.../salesforce}/salesforce-connection.adoc | 4 ----
.../transforms => snippets/salesforce}/salesforce-fields.adoc | 4 ----
.../transforms => snippets/salesforce}/salesforce-settings.adoc | 4 ----
.../hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc | 2 +-
.../modules/ROOT/pages/workflow/actions/pipeline.adoc | 2 +-
.../modules/ROOT/pages/workflow/actions/repeat-end.adoc | 2 +-
16 files changed, 23 insertions(+), 38 deletions(-)
diff --git a/.github/workflows/pr_build_docs.yml
b/.github/workflows/pr_build_docs.yml
index 51b89b54fb..10d08f324f 100644
--- a/.github/workflows/pr_build_docs.yml
+++ b/.github/workflows/pr_build_docs.yml
@@ -91,8 +91,8 @@ jobs:
# Antora turns a page's :description: into its meta description, the
# summary search engines and the site search show. Every published page
- # needs one. Files under pages/snippets are only included by other pages,
- # so they don't.
+ # needs one, and an empty :description: line counts as none. Files under
+ # pages/snippets are only included by other pages, so they don't.
#
# A page without one doesn't stop the job: it is written to checks.log in
# the format of Antora's JSON log, so "Report problems" lists it in the
PR
@@ -103,10 +103,10 @@ jobs:
run: |
touch "$RUNNER_TEMP/checks.log"
find docs -path '*/modules/ROOT/pages/*' -name '*.adoc' -not -path
'*/pages/snippets/*' \
- -exec grep -L '^:description:' {} + | sort | while read -r file;
do
+ -exec grep -L '^:description:[[:space:]]*[^[:space:]]' {} + |
sort | while read -r file; do
printf '{"level":"error","title":"Page
description","file":{"path":"%s","line":1},"msg":"%s"}\n' \
"$PWD/$file" \
- "Page without a description. Add a :description: line to its
header with a one-sentence summary of the page."
+ "Page without a description, or with an empty one. Add a
:description: line to its header with a one-sentence summary of the page."
done >> "$RUNNER_TEMP/checks.log"
- name: Check out the website build
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-execution-information.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-execution-information.adoc
index 20b8124556..12d3262d35 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-execution-information.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/hop-gui/perspective-execution-information.adoc
@@ -16,7 +16,7 @@ under the License.
////
:imagesdir: ../../assets/images/
:page-pagination:
-:description: An Apache Hop Execution Data Profile builds data profiles as
data flows through pipelines.
+:description: The Execution Information perspective shows the executions of
workflows and pipelines that ran before, and lets you drill down into their
details.
= Execution Information Perspective
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/mail-server-connection.adoc
b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/mail-server-connection.adoc
index e830ec5911..1b8e45a3c4 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/metadata-types/mail-server-connection.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/metadata-types/mail-server-connection.adoc
@@ -15,7 +15,7 @@ specific language governing permissions and limitations
under the License.
////
:page-pagination:
-:description:
+:description: A Mail server connection describes how Apache Hop connects to a
mail server, so actions like Mail can reuse it.
= Mail server connection
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 f5a6570cb0..54b78653f1 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
@@ -15,7 +15,7 @@ specific language governing permissions and limitations
under the License.
////
:page-pagination:
-:description:
+:description: A REST connection describes a REST API that transforms like the
REST client can reuse.
= REST connection
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-data-probe.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-data-probe.adoc
index 64f4cb0aba..01bcca0223 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-data-probe.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/pipeline-data-probe.adoc
@@ -16,7 +16,7 @@ under the License.
////
:documentationPath: /pipeline/transforms/
:language: en_US
-:description: The PGP Encrypt Stream transform encrypts text using PGP.
+:description: The Pipeline Data Probe transform receives the data that a
Pipeline Probe sends from the transforms it watches.
:page-engines: Hop Engine=yes, Single Threaded=yes, Native Spark=no, Beam
Spark=no, Beam Flink=no, Beam Dataflow=no
= image:icons/probe.svg[Pipeline Probe icon, role="image-doc-icon"] Pipeline
Data Probe
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforcedelete.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforcedelete.adoc
index 5f07ac4852..fd8a6dc8c3 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforcedelete.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforcedelete.adoc
@@ -44,9 +44,9 @@ Enter the following information in the transform name field:
* Transform name: Specifies the unique name of the Salesforce Delete transform
on the canvas.
You can customize the name or leave it as the default.
-include::salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-connection.adoc[]
-include::salesforce-settings.adoc[]
+include::../../snippets/salesforce/salesforce-settings.adoc[]
[options="noheader"]
|===
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinput.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinput.adoc
index 465e23515a..53d718f34e 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinput.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinput.adoc
@@ -44,7 +44,7 @@ NOTE: If your organization has enabled My Domain, you may see
'Restricted Domain
== Options
-include::salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-connection.adoc[]
== Settings
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinsert.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinsert.adoc
index c726884a68..31b4a69be0 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinsert.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceinsert.adoc
@@ -40,9 +40,9 @@ Enter the following information in the transform name field:
* Transform name: Specifies the unique name of the Salesforce Insert transform
on the canvas.
You can customize the name or leave it as the default.
-include::salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-connection.adoc[]
-include::salesforce-settings.adoc[]
+include::../../snippets/salesforce/salesforce-settings.adoc[]
=== Output Fields
@@ -50,4 +50,4 @@ Enter the output information in the following transform
option:
* Salesforce ID fieldname: Specifies the field to contain the Salesforce ID of
the first record in the set of records (batch) you inserted.
-include::salesforce-fields.adoc[]
\ No newline at end of file
+include::../../snippets/salesforce/salesforce-fields.adoc[]
\ No newline at end of file
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupdate.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupdate.adoc
index 2000bf28d9..ee28f57dba 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupdate.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupdate.adoc
@@ -40,11 +40,8 @@ Enter the following information in the transform name field:
* Transform name: Specifies the unique name of the Salesforce Update transform
on the canvas.
You can customize the name or leave it as the default.
-include::salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-settings.adoc[]
-=== Settings
-
-include::salesforce-settings.adoc[]
-
-include::salesforce-fields.adoc[]
\ No newline at end of file
+include::../../snippets/salesforce/salesforce-fields.adoc[]
\ No newline at end of file
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupsert.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupsert.adoc
index a05bcc5df2..fd97441b81 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupsert.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforceupsert.adoc
@@ -40,9 +40,9 @@ Enter the following information in the transform name field:
* Transform name: Specifies the unique name of the Salesforce Upsert transform
on the canvas.
You can customize the name or leave it as the default.
-include::salesforce-connection.adoc[]
+include::../../snippets/salesforce/salesforce-connection.adoc[]
-include::salesforce-settings.adoc[]
+include::../../snippets/salesforce/salesforce-settings.adoc[]
[options="noheader"]
|===
@@ -55,4 +55,4 @@ Enter the output information in the following transform
option:
Salesforce ID fieldname: Specifies the field to contain the Salesforce ID of
the first record in the set of records (batch) you updated and inserted.
-include::salesforce-fields.adoc[]
\ No newline at end of file
+include::../../snippets/salesforce/salesforce-fields.adoc[]
\ No newline at end of file
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-connection.adoc
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-connection.adoc
similarity index 96%
rename from
docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-connection.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-connection.adoc
index 6c5d6a9592..01ca22ac6d 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-connection.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-connection.adoc
@@ -14,10 +14,6 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-:documentationPath: /pipeline/transforms/
-:language: en_US
-:description: (not used directly )
-
=== Connection
The Salesforce transform can use a pre-defined
xref:metadata-types/salesforce-connection.adoc[Salesforce Connection] or use
inline connection settings directly. +
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-fields.adoc
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-fields.adoc
similarity index 94%
rename from
docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-fields.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-fields.adoc
index 46f652d2bf..40e8efdb58 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-fields.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-fields.adoc
@@ -14,10 +14,6 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-:documentationPath: /pipeline/transforms/
-:language: en_US
-:description: (not used directly )
-
=== Fields
You can specify what fields to insert into your Salesforce database through
the Fields table.
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-settings.adoc
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-settings.adoc
similarity index 94%
rename from
docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-settings.adoc
rename to
docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-settings.adoc
index 494c20abd2..12ce40302f 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/salesforce-settings.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/snippets/salesforce/salesforce-settings.adoc
@@ -14,10 +14,6 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
////
-:documentationPath: /pipeline/transforms/
-:language: en_US
-:description: (not used directly )
-
=== Settings
Enter the insert process settings in the following transform options:
diff --git a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
index 49cd882c8f..5ed60167a8 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/mql.adoc
@@ -16,7 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
-:description: The SQL action executes one or more SQL scripts from this
action's configuration or from a file.
+:description: The MongoDB QL action executes one or more JSON instructions on
a MongoDB database, from its configuration or from a file.
:page-marketplace: hop-tech-mongodb
= MongoDB QL
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
index 8583e42366..38f9dd7730 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/pipeline.adoc
@@ -16,7 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
-:description:
+:description: The Pipeline action runs a pipeline from a workflow.
= Pipeline
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
index 6673c903fc..4ccb790a90 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/workflow/actions/repeat-end.adoc
@@ -16,7 +16,7 @@ under the License.
////
:documentationPath: /workflow/actions/
:language: en_US
-:description:
+:description: The End repeat action stops a workflow that is run by the Repeat
action, at the next opportunity.
= End repeat
