Add MAN PAGES Documentation script#75
Merged
Merged
Conversation
74e6e27 to
e06a853
Compare
ambahman
reviewed
May 27, 2024
ambahman
left a comment
Contributor
There was a problem hiding this comment.
Why use two scripts, man_doc.go and md_doc.go, when we could use just one to generate Markdown files.
Member
Author
|
Contributor
|
we need md pages just for web UI |
Member
Author
Man pages are essential for every CLI tool, right? Are we missing something. |
Contributor
|
Disable those "Autogenerated by spf13/cobra" statement. |
Member
Author
|
ready for review @Vad1mo |
Member
Author
|
@Vad1mo ready to merge!!. This PR adds script for generating man pages doc. |
Contributor
|
The PR below is better at convincing for docs. |
Member
Author
We can use that for md docs for the website. This PR specifically focuses on Man docs |
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>
ae2d74e to
dda22bf
Compare
Signed-off-by: bupd <bupdprasanth@gmail.com>
Closed
Closed
Signed-off-by: bupd <bupdprasanth@gmail.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.