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

Generate manpages from tremor-cli clap definition #1469

Open
mfelsche opened this issue Feb 15, 2022 · 3 comments
Open

Generate manpages from tremor-cli clap definition #1469

mfelsche opened this issue Feb 15, 2022 · 3 comments
Labels
cli documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@mfelsche
Copy link
Member

Describe the problem you are trying to solve

We lost our cli.yaml due to a clap upgrade. But we generated docs for our website from this yaml file. So we cannot generate any docs on our cli anymore. It would be nice to have this docs.

Describe the solution you'd like

With https://crates.io/crates/clap_mangen we have a crate that we could use to generate manpages. Those could be used to be rendered to markdown or HTML and be displayed on the website and they could also be packaged alongside with our release packages.

@mfelsche mfelsche added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers cli labels Feb 15, 2022
@mfelsche mfelsche added this to the v0.12.0 milestone Feb 15, 2022
@AllMight2099
Copy link
Contributor

Hey there!
I'd like to pick this issue up

@mfelsche
Copy link
Member Author

@AllMight2099 hey, cool! One small concern though, we would need this rather soonish for the next release which is due soon. If you are fine with that extra pressure, i will assign this issue to you. As a strategy, rather make small iterative PRs or create a draft PR as soon as you have something, even if it is not yet quite working. We will provide feedback.

@AllMight2099
Copy link
Contributor

Hey @mfelsche. I'd love to work on this. I ran an example of clap-mangen and I'm ready to integrate it with my fork and submit a PR. Tho, I do have one doubt. Are the docs already present (as markdown files) or do I have to generate the documentation from the cli into markdown/HTML?
Will you be free to discuss this on discord as I could get started right away 😃

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants