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

Enhancements for CLI reference documentation #493

Open
jvanz opened this issue Jan 20, 2025 · 0 comments
Open

Enhancements for CLI reference documentation #493

jvanz opened this issue Jan 20, 2025 · 0 comments
Labels
area/documentation Improvements or additions to documentation kind/enhancement
Milestone
1.22

Comments

@jvanz
Copy link
Member

jvanz commented Jan 20, 2025 •
edited
Loading

Try to improve the CLI reference documentation files by removing the weird chars (e.g. right angled down pointing arrows) and generate asciidoc version of the file:

          looks ok. Is that right angled down pointing arrow useful/necessary?

          Also, can asciidoc be generated (in due course). Sorry, should have asked that earlier.

_Originally posted by @jhkrug in #491 (review)

Acceptance criteria

  • Consider a upstream contributation to add this features to clap_markdown
  • If the upstream contribution is not possible, manipulate the file copied from kwctl repository (and others, if they exists)
@jvanz jvanz added area/documentation Improvements or additions to documentation kind/enhancement labels Jan 20, 2025
@jvanz jvanz added this to the 1.22 milestone Jan 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation kind/enhancement
Projects
Kubewarden
Status: No status
Milestone
1.22
Development

No branches or pull requests
1 participant
@jvanz