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 11d9439410 Add missing pages to the docs navigation, fix the Snowflake
ID and Avro pages, remove the obsolete FAQ and duplicate Hop Search pages.
#8895 (#8898)
11d9439410 is described below
commit 11d9439410f8eff6fd35f6db830246b5132a15bf
Author: Adalennis <[email protected]>
AuthorDate: Wed Oct 14 09:54:50 2026 +0200
Add missing pages to the docs navigation, fix the Snowflake ID and Avro
pages, remove the obsolete FAQ and duplicate Hop Search pages. #8895 (#8898)
---
docs/hop-dev-manual/modules/ROOT/nav.adoc | 1 +
docs/hop-user-manual/modules/ROOT/nav.adoc | 4 ++
.../modules/ROOT/pages/faq/faq.adoc | 22 -------
.../modules/ROOT/pages/hop-search/index.adoc | 67 ----------------------
.../modules/ROOT/pages/hop-tools/hop-search.adoc | 7 ++-
.../pages/pipeline/transforms/snowflakeid.adoc | 2 +-
.../modules/ROOT/pages/technology/avro/index.adoc | 4 +-
.../modules/ROOT/pages/technology/technology.adoc | 1 +
8 files changed, 16 insertions(+), 92 deletions(-)
diff --git a/docs/hop-dev-manual/modules/ROOT/nav.adoc
b/docs/hop-dev-manual/modules/ROOT/nav.adoc
index 3e39cf3cd3..1916f17f95 100644
--- a/docs/hop-dev-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-dev-manual/modules/ROOT/nav.adoc
@@ -51,6 +51,7 @@ under the License.
*** xref:database/testing.adoc[Testing a database plugin]
*** xref:database/migrating-from-variants.adoc[Migrating from isXVariant()]
** xref:gui-plugins-toolbars.adoc[GUI plugins and toolbars]
+** xref:plugin-types/canvas-overlays.adoc[Canvas overlays]
** xref:annotation-derived-widgets.adoc[Annotation derived widgets]
** xref:engine-compatibility.adoc[Engine compatibility]
** xref:lineage.adoc[Lineage observation hub]
diff --git a/docs/hop-user-manual/modules/ROOT/nav.adoc
b/docs/hop-user-manual/modules/ROOT/nav.adoc
index 90b4630e79..7839154912 100644
--- a/docs/hop-user-manual/modules/ROOT/nav.adoc
+++ b/docs/hop-user-manual/modules/ROOT/nav.adoc
@@ -147,6 +147,7 @@ under the License.
*** xref:pipeline/transforms/combinationlookup.adoc[Combination lookup/update]
*** xref:pipeline/transforms/concatfields.adoc[Concat fields]
*** xref:pipeline/transforms/copyrowstoresult.adoc[Copy rows to result]
+*** xref:pipeline/transforms/cratedb-bulkloader.adoc[CrateDB Bulk Loader]
*** xref:pipeline/transforms/creditcardvalidator.adoc[Credit card validator]
*** xref:pipeline/transforms/csvinput.adoc[CSV file input]
*** xref:pipeline/transforms/cypher-builder.adoc[Cypher builder]
@@ -307,6 +308,7 @@ under the License.
*** xref:pipeline/transforms/sftpput.adoc[SFTP Put]
*** xref:pipeline/transforms/simple-mapping.adoc[Simple Mapping]
*** xref:pipeline/transforms/snowflakebulkloader.adoc[Snowflake bulk loader]
+*** xref:pipeline/transforms/snowflakeid.adoc[Snowflake ID Generator]
*** xref:pipeline/transforms/sort.adoc[Sort Rows]
*** xref:pipeline/transforms/sortedmerge.adoc[Sorted Merge]
*** xref:pipeline/transforms/sortedschemamerge.adoc[Sorted schema merge]
@@ -590,7 +592,9 @@ under the License.
* xref:technology/technology.adoc[Technology]
** xref:technology/ai/index.adoc[AI]
** xref:technology/age/index.adoc[Apache AGE]
+** xref:technology/arrow/apache-arrow.adoc[Apache Arrow]
** xref:technology/calcite/index.adoc[Apache Calcite]
+** xref:technology/avro/index.adoc[Avro]
** xref:technology/azure/index.adoc[Azure]
** xref:technology/cassandra/index.adoc[Cassandra]
** xref:technology/falkordb/index.adoc[FalkorDB]
diff --git a/docs/hop-user-manual/modules/ROOT/pages/faq/faq.adoc
b/docs/hop-user-manual/modules/ROOT/pages/faq/faq.adoc
deleted file mode 100644
index d2b7ff5e19..0000000000
--- a/docs/hop-user-manual/modules/ROOT/pages/faq/faq.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.
-////
-[[Faq]]
-= Frequently Asked Questions
-
-This page contains some of the frequently asked question
-
-== Questions
\ No newline at end of file
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-search/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-search/index.adoc
deleted file mode 100644
index e9601ab550..0000000000
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-search/index.adoc
+++ /dev/null
@@ -1,67 +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: Hop Search is a command line tool which allows you to search in
your projects. It's particularly useful if you're working on a remote server
over a ssh connection and you need to find a certain value, setting, transform,
action and so on.
-[[HopSearch]]
-= Hop Search
-
-== Description
-
-Hop Search is a command line tool which allows you to search in your projects.
-It's particularly useful if you're working on a remote server over a ssh
connection and you need to find a certain value, setting, transform, action and
so on.
-
-The search will match names, keys, values, descriptions and so on.
-
-== Options
-
-|===
-|Option |Description |Default value| Available for plugin
-
-|`-j` or `--project`
-|The name of the project you want to search in
-|None or the configured default project when none is specified
-|Projects
-
-|`-e` or `--environment`
-|The environment to search in
-|None or the configured default environment when none is specified
-|Projects
-
-|`-h` or `--help`
-|Print the help options
-|None
-|
-
-|`-i` or `--case-insensitive`
-|Perform a case insensitive search
-|false
-|
-
-|`-x` or `--regular-expression`
-|The specified search string is a (Java)
https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html[regular
expression]
-|false
-|
-
-|`-l` or `--print-locations`
-|Print which locations are being looked at
-|false
-|
-
-|`-v` or `--version`
-|Print version information
-|false
-|
-|===
diff --git a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
index a12394c3de..e11171c6d8 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/hop-tools/hop-search.adoc
@@ -19,6 +19,11 @@ under the License.
= Hop Search
Hop Search is a command line tool to search for metadata in Hop or a Hop
project.
+It is particularly useful when you work on a remote server over an SSH
connection and need to find a value, setting, transform or action.
+
+The search matches names, keys, values, descriptions and so on.
+
+Without `-j` and `-e`, Hop Search uses the default project and environment
from the Hop configuration.
+
@@ -65,7 +70,7 @@ Usage: <main class> [-hilx] [-e=<environmentOption>]
[-j=<projectOption>]
== Examples
-Example command: search for the string 'json' (case insensitive) in the
'hop-samples' project.
+Example command: search for the string 'switch-case' (case insensitive) in the
'samples' project.
[tabs]
====
diff --git
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/snowflakeid.adoc
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/snowflakeid.adoc
index e7e00a6c69..2312fcccc3 100644
---
a/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/snowflakeid.adoc
+++
b/docs/hop-user-manual/modules/ROOT/pages/pipeline/transforms/snowflakeid.adoc
@@ -16,7 +16,7 @@ under the License.
////
:documentationPath: /pipeline/transforms/
:language: en_US
-:description: The Snowflake id transform generates a unique id for snowflake
rows
+:description: The Snowflake ID Generator transform generates globally unique,
time-ordered 64-bit IDs with the Snowflake ID algorithm.
:page-engines: Hop Engine=yes, Single Threaded=yes, Native Spark=yes, Beam
Spark=maybe, Beam Flink=maybe, Beam Dataflow=maybe
= image:transforms/icons/addsnowflakeid.svg[Snowflake ID Generator transform
Icon, role="image-doc-icon"] Snowflake ID Generator
diff --git a/docs/hop-user-manual/modules/ROOT/pages/technology/avro/index.adoc
b/docs/hop-user-manual/modules/ROOT/pages/technology/avro/index.adoc
index 6b64c60866..5983545ee5 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/technology/avro/index.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/technology/avro/index.adoc
@@ -31,7 +31,9 @@ First and foremost we support Avro as a data type called
"Avro Record". It simp
== Pipeline Transforms
* xref:pipeline/transforms/avro-decode.adoc[Avro decode]: This allows you to
extract Hop values from an Avro Record data type.
-* xref:pipeline/transforms/avro-encode.adoc[Avro encode]: This allows you to
extract Hop values from an Avro Record data type.
+* xref:pipeline/transforms/avro-encode.adoc[Avro encode]: This allows you to
build an Avro Record from a selection of Hop fields.
+* xref:pipeline/transforms/avro-file-input.adoc[Avro file input]: This allows
you to read Avro records from one or more files.
+* xref:pipeline/transforms/avro-file-output.adoc[Avro file output]: This
allows you to write Avro records to a file or a field.
== Kafka producer transforms
diff --git a/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
b/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
index 2b9f9fc1dd..1f9af6445f 100644
--- a/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
+++ b/docs/hop-user-manual/modules/ROOT/pages/technology/technology.adoc
@@ -29,6 +29,7 @@ The technologies supported by Hop currently include:
* xref:technology/age/index.adoc[Apache AGE]
* xref:technology/arrow/apache-arrow.adoc[Apache Arrow]
* xref:technology/calcite/index.adoc[Apache Calcite]
+* xref:technology/avro/index.adoc[Avro]
* xref:technology/azure/index.adoc[Azure]
* xref:technology/cassandra/index.adoc[Apache Cassandra]
* xref:technology/falkordb/index.adoc[FalkorDB]
