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.

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

Add reference docs for past releases #460

Open
17 tasks
tjtelan opened this issue Nov 19, 2022 · 0 comments
Open
17 tasks

Add reference docs for past releases #460

tjtelan opened this issue Nov 19, 2022 · 0 comments

Comments

@tjtelan
Copy link
Contributor

tjtelan commented Nov 19, 2022

Goal is to automate the collection of docs directly from the repos and provide them in a list by their stable version number.

There are lots of different artifacts so this will probably be a tracking issue until there's a maintainable way to collect these.

CLI docs

API docs

Connector docs

Inbound

Outbound

Certified Hub SmartModules

  • jolt
  • json-sql
  • regex

(A stretch goal is to include Changelogs in addition to docs, but that's large enough to deserve its own issue.)


There are 2 parts to this strategy

  1. We need to update release a lot of the pipelines to add the generated docs to Github Releases.
  2. Write the automation to collect the latest docs

Just a suggestion for implementation, but I would like to maintain a list of the docs types in https://github.com/infinyon/fluvio-website/tree/master/data. This list will allow us to build a template for hugo use for generating links.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant