Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Revive streampipes-maven-plugin to auto-generate pipeline element documentation #1906

Closed
dominikriemer opened this issue Sep 10, 2023 · 1 comment · Fixed by #1907
Closed

Revive streampipes-maven-plugin to auto-generate pipeline element documentation #1906

dominikriemer opened this issue Sep 10, 2023 · 1 comment · Fixed by #1907
Assignees
@dominikriemer
Labels
documentation Everything related to documentation enhancement New feature or request
Milestone
0.93.0

Comments

@dominikriemer
Copy link
Member

Body

To keep our documentation up-to-date with existing adapters and pipeline elements, refactor the streampipes-maven-plugin:

  • Auto-discover existing pipeline elements
  • Generate Docusaurus-compatible Markdown from documentation.md files
  • Automatically run the plugin in the package phase
  • Add Github action to create a pull request in streampipes-website with updated documentation files

StreamPipes Committer

I acknowledge that I am a maintainer/committer of the Apache StreamPipes project.
@dominikriemer dominikriemer added enhancement New feature or request documentation Everything related to documentation labels Sep 10, 2023
@dominikriemer dominikriemer added this to the 0.93.0 milestone Sep 10, 2023
@dominikriemer dominikriemer self-assigned this Sep 10, 2023
@dominikriemer dominikriemer linked a pull request Sep 10, 2023 that will close this issue
Refactor streampipes-maven-plugin to auto-generate docs #1907
Merged
@bossenti
Copy link
Contributor

PR in streampipes-website: apache/streampipes-website#107

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dominikriemer dominikriemer

Labels
documentation Everything related to documentation enhancement New feature or request
Projects
None yet
Milestone
0.93.0
Development

Successfully merging a pull request may close this issue.

Refactor streampipes-maven-plugin to auto-generate docs apache/streampipes
2 participants
@dominikriemer @bossenti