Add MAN PAGES Documentation script #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bupd
force-pushed
the
documentation
branch
2 times, most recently
from
74e6e27 to
e06a853
Compare
amands98
reviewed
May 27, 2024
|
|
we need md pages just for web UI |
Man pages are essential for every CLI tool, right? Are we missing something. |
|
Disable those "Autogenerated by spf13/cobra" statement. |
|
ready for review @Vad1mo |
|
@Vad1mo ready to merge!!. This PR adds script for generating man pages doc. |
|
The PR below is better at convincing for docs. |
We can use that for md docs for the website. This PR specifically focuses on Man docs |
bupd
added
documentation
bupd
changed the title
Signed-off-by: bupd <bupdprasanth@gmail.com> add: auto documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
Signed-off-by: bupd <bupdprasanth@gmail.com>
bupd
force-pushed
the
documentation
branch
2 times, most recently
from
ae2d74e to
dda22bf
Compare
Signed-off-by: bupd <bupdprasanth@gmail.com>
Closed
Closed
Signed-off-by: bupd <bupdprasanth@gmail.com>
Standing-Man
pushed a commit
to Standing-Man/harbor-cli
that referenced
this pull request
Feb 5, 2025
* add: auto man documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> add: auto documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> * remove md_doc generation & add man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update dagger for generating man pages Signed-off-by: bupd <bupdprasanth@gmail.com> * update github workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * update man doc generation Signed-off-by: bupd <bupdprasanth@gmail.com> * add cli and man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * move man pages to man1 Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Alan Tang <jmtangcs@gmail.com>
Standing-Man
pushed a commit
to Standing-Man/harbor-cli
that referenced
this pull request
Feb 5, 2025
* add: auto man documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> add: auto documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> * remove md_doc generation & add man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update dagger for generating man pages Signed-off-by: bupd <bupdprasanth@gmail.com> * update github workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * update man doc generation Signed-off-by: bupd <bupdprasanth@gmail.com> * add cli and man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * move man pages to man1 Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com>
Standing-Man
pushed a commit
to Standing-Man/harbor-cli
that referenced
this pull request
Feb 5, 2025
* add: auto man documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> add: auto documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> * remove md_doc generation & add man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update dagger for generating man pages Signed-off-by: bupd <bupdprasanth@gmail.com> * update github workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * update man doc generation Signed-off-by: bupd <bupdprasanth@gmail.com> * add cli and man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * move man pages to man1 Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Alan Tang <jmtangcs@gmail.com>
Standing-Man
pushed a commit
to Standing-Man/harbor-cli
that referenced
this pull request
Feb 5, 2025
* add: auto man documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> add: auto documentation generate scripts Signed-off-by: bupd <bupdprasanth@gmail.com> * remove md_doc generation & add man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update dagger for generating man pages Signed-off-by: bupd <bupdprasanth@gmail.com> * update github workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * update man doc generation Signed-off-by: bupd <bupdprasanth@gmail.com> * add cli and man docs Signed-off-by: bupd <bupdprasanth@gmail.com> * update workflow Signed-off-by: bupd <bupdprasanth@gmail.com> * move man pages to man1 Signed-off-by: bupd <bupdprasanth@gmail.com> --------- Signed-off-by: bupd <bupdprasanth@gmail.com> Signed-off-by: Alan Tang <jmtangcs@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes: #49
Description:
Created script to automate document generation for the cli.
CLI Documentation:
Markdown:
Screenshots:
Below is the example of documentation in markdown format for the
harbor projectcommand.Below is the example of documentation in man format for the
harbor projectcommand.