mattcasters opened a new issue, #8646: URL: https://github.com/apache/hop/issues/8646
### What needs to happen? The developer documentation SDK section documents a few popular use-cases for pipelines and workflows, mostly orchestrating them. We need to split up this information, move the overview page to `sdk/index.adoc` and create smaller pages under the SDK. An important top topic to improve is how to work with metadata elements, HopMetadataProperty, IHopMetadataProvider / Serializer, purpose of Memory & Multi providers, serializing to JSON, GUI usage : Metadata editors and MetaSelectionLine in dialogs. Then there are an important new topics to cover: working with files using HopVFS, the importance of closing resources, of avoiding java.util.File, links to VFS docs elsewhere and in the (user) docs. I also want to see a new section in the SDK documentation where we document Hop plugins of various types. Part of it is moving existing documentation under the topic, part of it is writing new content. Obviously we want to document how to create a new transform or action plugin, but also document making a plugin for a new metadata element, database metadata, GUI plugin for a toolbar item, panel, ..., a Hop file type, a Variable Resolver, extension point, hop command, configuration, perspective, VFS, Value metadata, hop server servlet, execution information location, to get started. Link to and mention concrete examples in our own source code to clarify how these work. ### Issue Priority Priority: 3 ### Issue Component Component: Documentation, Component: API -- 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]
