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

feat(reference): Update and expand reference CLI sections #75

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

pau-hedgehog
Copy link
Contributor

Updated hhfabctl section. Added hhfab section.

@pau-hedgehog pau-hedgehog self-assigned this Mar 16, 2025
Copy link

github-actions bot commented Mar 16, 2025

🚀 Deployed on https://preview-75--hedgehog-docs.netlify.app

@github-actions github-actions bot temporarily deployed to pull request March 16, 2025 22:54 Inactive
Copy link
Member

@qmonnet qmonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great, but this will be painful to keep up-to-date. Is there a way to automate this doc?

The reference I have in mind is how Cilium uses spf13/cobra's GenMarkdownTreeCustom() (in its cmdref package) to generate references for all CLI commands. I know we don't use viper and cobra, but if there were some equivalent available so that we could auto-generate most of these docs, it would be nice.

@pau-hedgehog
Copy link
Contributor Author

Looks great, but this will be painful to keep up-to-date. Is there a way to automate this doc?

The reference I have in mind is how Cilium uses spf13/cobra's GenMarkdownTreeCustom() (in its cmdref package) to generate references for all CLI commands. I know we don't use viper and cobra, but if there were some equivalent available so that we could auto-generate most of these docs, it would be nice.

Although this was sort of a proof of concept you raise a very good point.

A quick search gave me: https://github.com/urfave/cli-docs

I can explore it

@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 22:29 Inactive
@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 22:33 Inactive
Updated hhfabctl section. Added hhfab section.

Signed-off-by: Pau Capdevila <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request March 17, 2025 23:06 Inactive
Signed-off-by: Pau Capdevila <[email protected]>
@github-actions github-actions bot temporarily deployed to pull request March 18, 2025 14:58 Inactive
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

Successfully merging this pull request may close these issues.

2 participants