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

   Fixes #8979
   
   Rewrites `templates/template-plugin.adoc` (the starting point for plugin 
pages, according to the developer manual's "Writing documentation" page) so it 
can be copied as is:
   
   - A short comment on how to use it: where to copy it, what to replace, 
adding the page to the navigation, and how the plugin's `documentationUrl` 
relates to the page.
   - The header attributes the existing pages use, each with a comment: 
`:documentationPath:`, `:language:`, `:description:` (required by the docs PR 
build since #8957), `:page-engines:` for transforms only, with the meaning of 
yes / no / maybe / native, and `:page-marketplace:` for marketplace plugins 
only.
   - The title with the icon for a transform, and a note that an action page 
has no icon.
   - Description and Options sections with the options table and its first row, 
for transforms and actions. The existing writing tips are kept, in the Options 
section where they apply.
   - The optional sections used on several pages.
   
   All of it follows what the 276 transform pages and 84 action pages have in 
common. One template is kept rather than two, so the reference from the 
developer manual still holds.
   
   
   - [x] Run `mvn clean install apache-rat:check` to make sure basic checks 
pass. A more thorough check will be performed on your pull request 
automatically.
   - [x] If you have a group of commits related to the same change, please 
squash your commits into one and force push your branch using `git rebase -i`.
   - [x] Mention the appropriate issue in your description (for example: 
`addresses #123`), if applicable.
   
   To make clear that you license your contribution under the [Apache License 
Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
   you have to acknowledge this by using the following check-box.
   
   - [x] I hereby declare this contribution to be licensed under the [Apache 
License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
   - [ ] In any other case, please file an [Apache Individual Contributor 
License Agreement](https://www.apache.org/licenses/icla.pdf).
   


-- 
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