kstna23 commented on issue #5539: URL: https://github.com/apache/hop/issues/5539#issuecomment-3133917542
thanks for coming back @mattcasters :) For me personally these have been the reasons to actively ask for Markdown, but I am also happy with HTML-Docs converted by AsciiDoc (what is easier to implement). Pro's of Markdown (for me): - No dependency on external plugins - Markdown should be easier to create and in my opinion leaner, easier to handle - Markdown getting more and more present (or the de-facto standard 😄) for documentation, technical teams and technical docs - Easy to maintain and share with Business Users, Analysts & Teams with built-in features of GitHub, GitLab, Bitbucket for example. - Easy to Update, Insert .md documentation-files into MkDocs or GitPages via CI/CD or with Hop Pipelins/Workflows to automatically generate .md files & store them in the MkDocs Repository or an S3 Bucket. - With this a Static Project Documentation with minimum effort is achievable. --> Means always up to date documentation of the Hop-Project automatically generated and curated. You just need to adapt the index.md and the navigation one time (reference: https://www.mkdocs.org/getting-started/) and automatically use the extracted Hop.md as subpages per Pipeline/Workflow and the Project is documented with nearly no effort and always up to date in terms of the Pipelines and Workflows. - Markdown-Files can be directly adapted in Git-Repositories in the Browser, as the Raw-Format is still human-readable and also a lot of CI tools automatically render Markdown without any additional tool to edit. Hope this helps as feedback. But like said I would also be happy with an HTML-Export. ❤️ -- 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]
