docs: auto generate pouch cli/api docs via code #2322
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
Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
Codecov Report
@@ Coverage Diff @@
## master #2322 +/- ##
=========================================
+ Coverage 65.95% 66.9% +0.94%
=========================================
Files 217 218 +1
Lines 17652 17943 +291
=========================================
+ Hits 11642 12004 +362
+ Misses 4631 4522 -109
- Partials 1379 1417 +38
|
lnky79
reviewed
Oct 18, 2018
| @@ -4,88 +4,27 @@ Upgrade a container with new image and args | |||
|
|
|||
| ### Synopsis | |||
|
|
|||
| Upgrade a container with new image and args | |||
| upgrade is a feature to replace a container's image.You can specify the new Entrypoint and Cmd for the new container. When you want to updatea container's image, but inherit the network and volumes of the old container, then you shouldthink about the upgrade feature. | |||
There was a problem hiding this comment.
Here is a typo: When you want to updatea container's ** should be update a.
There was a problem hiding this comment.
Yes, you are right. Since this is an auto-generated pull request. Could you please help to fix the source doc of https://github.com/alibaba/pouch/blob/master/cli/upgrade.go#L15 to add a white space?6 This could be done via your new pull request. @lyn716
var upgradeDescription = "upgrade is a feature to replace a container's image." +
"You can specify the new Entrypoint and Cmd for the new container. When you want to update" +
"a container's image, but inherit the network and volumes of the old container, then you should" +
"think about the upgrade feature."
|
LGTM, merge this. |
pouchrobot
added
the
LGTM
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.
Signed-off-by: pouchrobot pouch-dev@alibaba-inc.com
1.Describe what this PR did
This PR is automatically done by AI-based collaborating robot.
Pouchrobot will auto-generate cli/api document via https://github.com/spf13/cobra/tree/master/doc every day.
2.Does this pull request fix one issue?
None
3.Describe how you did it
First, execute command "make client" to build new pouch cli;
Second, execute command "./pouch gen-doc" to generate new cli docs.
For API part, we use a tool swagger2markup to make it.
4.Describe how to verify it
None
5.Special notes for reviews
The cli/api doc must be automatically generated.