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

   ### What needs to happen?
   
   #8786 and #8790 added samples for all transforms and actions to the samples 
project (#2237, #2238), but the documentation pages don't point to them.
   
   On main, 288 transform and action pages have at least one sample shipped 
with the same plugin, matched through the `documentationUrl` of the 
`@Transform` / `@Action` annotation. Only 15 of these pages name one of those 
samples. 273 pages don't: 210 transforms and 63 actions.
   
   Proposal: add a short section to each of these pages, the way the Surefire 
report output page does it:
   
   ```asciidoc
   == Samples
   
   The samples project has `transforms/surefire-report-output.hpl`, which 
writes a report for two tests from a Data grid.
   ```
   
   - Only the samples shipped with the transform's or action's own plugin, not 
every sample where it appears.
   - One sentence per sample, no screenshots, so there is nothing to keep up to 
date when a sample changes.
   - Done in batches, one PR per group of pages.
   
   ### 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