You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@hop.apache.org by "Adalennis (via GitHub)" <gi...@apache.org> on 2026/10/13 12:21:15 UTC

[I] [Task]: Documentation pages missing from the navigation (hop)

Adalennis opened a new issue, #8895:
URL: https://github.com/apache/hop/issues/8895

   ### What needs to happen?
   
   Six documentation pages are not listed in `nav.adoc` and no other page links to them, so readers cannot reach them from the site:
   
   User manual:
   - `pipeline/transforms/snowflakeid.adoc` (Snowflake ID Generator): the transform exists (`plugins/databases/snowflake`, `AddSnowflakeId`), but the page was never added to the transforms list in the navigation. Its `:description:` is also misleading ("generates a unique id for snowflake rows"): the transform generates IDs with the Snowflake ID algorithm and is not related to the Snowflake database.
   - `pipeline/transforms/cratedb-bulkloader.adoc` (CrateDB Bulk Loader): missing from the transforms list.
   - `technology/avro/index.adoc` (Avro): missing from the Technology section (the breadcrumb shows "Home / Avro" instead of "Home / Technology / Avro"). The page also describes Avro encode with the Avro decode text ("extract Hop values from an Avro Record"), and its transform list leaves out Avro file input and Avro file output.
   
   Developer manual:
   - `plugin-types/canvas-overlays.adoc` (Canvas overlays, 354 lines): added in #8349 together with Diagram exporters, but only Diagram exporters was added to the navigation. The page itself says it is not a separate plugin type (it is built on `@ExtensionPoint`), so it fits better under Plugin development, next to "GUI plugins and toolbars", than under Plugin types.
   
   Pages that look obsolete, to discuss:
   - `hop-search/index.adoc` is an older copy of `hop-tools/hop-search.adoc`, which is the page listed in the navigation. Proposal: remove it.
   - `faq/faq.adoc` only contains a title and an empty "Questions" section. Proposal: remove it.
   
   Published pages (reachable only by URL):
   - https://hop.apache.org/manual/latest/pipeline/transforms/snowflakeid.html
   - https://hop.apache.org/manual/latest/pipeline/transforms/cratedb-bulkloader.html
   - https://hop.apache.org/manual/latest/technology/avro/index.html
   - https://hop.apache.org/manual/latest/hop-search/index.html
   - https://hop.apache.org/manual/latest/faq/faq.html
   - https://hop.apache.org/dev-manual/next/plugin-types/canvas-overlays.html
   
   Proposed fix: add the first four pages to `nav.adoc` in alphabetical order, correct the Snowflake ID description and the Avro page (encode description, missing file input/output transforms), and remove the two obsolete pages unless someone prefers to keep them.
   
   ### Issue Priority
   
   Priority: 3
   
   ### Issue Component
   
   Component: Documentation


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Task]: Documentation pages missing from the navigation (hop)

Posted by "Adalennis (via GitHub)" <gi...@apache.org>.
Adalennis commented on issue #8895:
URL: https://github.com/apache/hop/issues/8895#issuecomment-6145420716

   .take-issue


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [I] [Task]: Documentation pages missing from the navigation (hop)

Posted by "hansva (via GitHub)" <gi...@apache.org>.
hansva closed issue #8895: [Task]: Documentation pages missing from the navigation
URL: https://github.com/apache/hop/issues/8895


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@hop.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org