kstna23 opened a new issue, #5539: URL: https://github.com/apache/hop/issues/5539
### What would you like to happen? It would be highly beneficial to have a built-in feature in Apache Hop that allows users to export their Hop jobs and pipelines as Markdown (.md) documentation. This would be similar in spirit to the HTML documentation export feature in Talend Open Studio, which provides a readable and shareable summary of job logic and metadata. Rationale and Benefits: Documentation Automation: Automatically generate Markdown documentation from Hop jobs/pipelines to improve maintainability and transparency. Version Control Friendly: Markdown is text-based and works seamlessly with Git and other version control systems. Portability: Markdown files can be easily rendered and viewed in many platforms including GitHub, GitLab, Bitbucket, and static site generators like MkDocs. Collaboration: Makes it easier for business analysts, technical writers, and team members to understand workflows without opening Hop itself. Suggested Features: Export entire project or selected jobs/pipelines to .md files. Include job/pipeline name, description, parameters, metadata, notes, and a readable outline of the workflow steps. Optionally include a diagram (embedded image or ASCII representation). Include details of each transform/action: name, plugin type, config summary. Optional toggle to include technical details (e.g., field mappings, SQL, scripts). CLI support for headless export as part of CI/CD pipelines. Example Output Structure: markdown Kopieren Bearbeiten # Job: Load_Customer_Data **Description:** This job loads customer data from CSV into the staging database. ## Parameters - `input_file`: Path to customer CSV file - `target_table`: Destination database table ## Workflow Overview 1. **Start** 2. **Read Customer CSV** (CSV Input) 3. **Validate Data** (Filter Rows) 4. **Insert to DB** (Table Output) 5. **End** ## Notes This job should be scheduled to run daily at midnight. Additional Context: This would be very useful for teams that want to: Generate technical documentation as part of their delivery process Improve onboarding by providing human-readable overviews Maintain traceability between design and implementation ### 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]
