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

   ### What needs to happen?
   
   `docs/hop-user-manual/modules/ROOT/templates/template-plugin.adoc` only 
holds a title and a few writing tips. It has none of the header attributes the 
plugin pages use, no icon in the title, and no Description or Options section, 
although its tips refer to the Options table.
   
   As a result, new pages are written without a description or an engines 
section, or copy them from older pages: seven pages still had the old 
"Supported Engines" table until #8958. Since #8957, a page without a 
description fails the docs PR build.
   
   What the existing pages have in common (276 transform pages, 84 action 
pages):
   
   | | Transforms | Actions |
   |---|---|---|
   | `:documentationPath:`, `:language:`, `:description:` | all | all |
   | `:page-engines:` | all | none |
   | `:page-marketplace:` | 69 (marketplace plugins) | 12 |
   | Icon in the title (`role="image-doc-icon"`) | 274 | none |
   | `== Description` / `== Options` | 276 / 247 | 82 / 78 |
   | Optional sections used on several pages | Notes, Usage, Examples, 
Limitations, Output fields, See also, Metadata injection | Examples, Usage, 
Tips |
   
   Turn the template into one that can be copied, keeping the current tips:
   - the header attributes, with a short comment on each: `:page-engines:` for 
transforms only, with the values it takes (yes, no, maybe, native), and 
`:page-marketplace:` only for plugins installed from the marketplace;
   - the title, with the icon for a transform and without it for an action;
   - Description and Options sections with an empty options table, and a 
mention of the optional sections.
   
   Alternatively, split it into a transform template and an action template.
   
   
   ### 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: [email protected]

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

Reply via email to