hansva opened a new pull request, #8189:
URL: https://github.com/apache/hop/pull/8189

   Fixes #8188.
   
   The tech manual held 12 pages: half untouched since 2021, an empty "Getting 
Started" stub that rendered as a blank page in the nav, and a logging-plugin 
page whose text was "Example source code is available for a log4j plugin 
(somewhere - ask Matt)".
   
   "Technical" was never a rule a contributor could apply, and it showed — 
Docker was documented in all three manuals at once (`docker-container` in tech, 
`docker-build` in dev, `deploy-project-image` in user), and `hop-import` had 
two near-identical pages in two manuals.
   
   Every page moves to the manual that already owns its subject:
   
   | Page | New home |
   |---|---|
   | `getting-started.adoc`, `index.adoc` | dropped — an empty stub and a bare 
link list |
   | `docker-container.adoc` | user manual, nav entry "Hop in Docker" |
   | `hop-web-docker.adoc` | user manual, under the same entry |
   | `disable-ui-elements.adoc` | user manual, under Hop Gui |
   | `hop-vs-kettle/*` | user manual, in the nav right after Getting Started |
   | `hop-vs-kettle/hop-import.adoc` | merged into the existing 
`hop-tools/hop-import.adoc` |
   | `logging/logging-architecture.adoc`, `udjc-logging.adoc` | developer 
manual, `architecture/logging-and-debugging.adoc` |
   | `logging/logging-plugins.adoc` | dropped, see below |
   | `hop-logo-and-icons.adoc` + 30 image copies | dropped — hop.apache.org 
already hosts the same brand assets under `/graphical_resources/` |
   
   The two import pages were complementary, not duplicates: the tool page had 
the CLI usage and examples, the tech page had what actually gets converted and 
the fuller dialog table. They are now one page each for the CLI and the GUI 
walkthrough, cross-linked, with no repeated table. The dialog defaults were 
checked against `KettleImportDialog` and `HopImportBase` rather than copied 
over on trust.
   
   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 so the third manual does not grow back.
   
   `logging-plugins.adoc` is dropped rather than moved: `LoggingPluginType` is 
not in `HopEnvironment.getStandardPluginTypes()`, nothing else registers it, 
and there are no `@LoggingPlugin` implementations in the repo. Documenting it 
would advertise an extension point that cannot load. Worth its own issue.
   
   **Validation:** a full Antora build over both manuals reports no unresolved 
xrefs and no missing nav targets. The remaining warnings are pre-existing 
missing-attribute noise in unrelated pages.
   
   **Companion PR:** apache/hop-website removes the component from the Antora 
playbooks and the menu, adds a Community > Logo and Icons page, and redirects 
every `/tech-manual/<version>/*` URL to its new home. Both should merge 
together.
   
   🤖 Generated with [Claude Code](https://claude.com/claude-code)


-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to