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

CLI Documentation #49

Closed
2 tasks
Vad1mo opened this issue May 17, 2024 · 3 comments · Fixed by #199 · May be fixed by #75
Closed
2 tasks

CLI Documentation #49

Vad1mo opened this issue May 17, 2024 · 3 comments · Fixed by #199 · May be fixed by #75

Comments

@Vad1mo
Copy link
Member

Vad1mo commented May 17, 2024 •
edited
Loading

We need to create and build some sort of documentation regarding the CLI and its basic and advances usage.
Ideally something that can used on the CLI but also in the online form in Markdown.

Goal would be to generate a markdown in e.g docs dir, this dir would then imported by https://github.com/goharbor/website and rendered on as a page on goharbor.io/
@criticic
Copy link

criticic commented May 18, 2024 •
edited
Loading

For many command-line users, one of the most used documentation, is the software's manpage, we can use a library like go-md2man, to convert our markdown documentations to man format.

@bupd
Copy link
Collaborator

bupd commented May 26, 2024

We can use cobra/doc to automate docs generation in markdown and man for cli.

@bupd bupd mentioned this issue May 26, 2024
Open
@Althaf66 Althaf66 mentioned this issue Jun 9, 2024
Closed
@karanngi
Copy link

karanngi commented Aug 1, 2024

Can I work @Vad1mo

@Althaf66 Althaf66 mentioned this issue Sep 29, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Harbor CLI
Status: Done
Milestone
No milestone
4 participants
@Vad1mo @criticic @bupd @karanngi