Hi Hans, All, I agree moving the plugin documentation out of the plugins category is a necessity. Our initial structure was inspired by the Hop architecture, which imho is a way too technical perspective. The documentation structure should follow how people use Hop and where they would look for information.
People will interact with transforms, actions, project & database config etc almost exclusively from Hop Gui. Therefore, my suggestion would be to use the 2 main 'Workflow' and 'Pipeline' sections you mentioned, but keep them in the Hop Gui section. Something like: - > Hop Gui - - > Workflows - - -> Workflow Editor - - - > Workflow Run Configurations - - - > Actions - - - > .... - - > Pipelines - - - > Pipeline Editor - - - > Pipeline Run Configurations - - - > Transforms - - - > .... - - > Testing - - > Projects & Environments - - > Metadata - - - > Databases - - > .... For the more configuration/administration oriented tasks, we could add a Tools/Administration/Configuration section, something like: - > Tools (or Administration?) - - > Hop Conf - - > Hop Server - - > Hop Run I'm not sure where e.g. the password plugins would fit in, since they're not directly development or configuration related. We could keep those in the current 'Plugins' section. - > Plugins - - > Password Plugins Regards, Bart On Sun, Feb 21, 2021 at 9:46 AM Hans Van Akelyen <hans.van.akel...@gmail.com> wrote: > Hi Hoppers, > > I would like to restructure the documentation a bit and would love for your > opinion on the matter. > Currently all our transforms and actions are gathered under the plugins > section, this made sense when we started working on the project but from a > user perspective this is confusing. > > The suggestion is to make at least 2 large categories to the documentation > being "Pipeline" and "Workflow" we can then move the documentation that is > located under "Hop Gui" or rewrite parts of this documentation and do cross > references when needed. > > I think making these 2 large sections and adding the transforms/actions > here will greatly improve readability. We can still use the plugins section > too, we can use it for external plugins or transforms/actions that we will > not be adding to the default release in the future. > > Cheers, > Hans >
