This repository has been archived by the owner on Feb 27, 2023. It is now read-only.
docs: auto generate Dragonfly cli/api/contributors docs via code #1151
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 #1151 +/- ##
==========================================
- Coverage 47.24% 47.23% -0.02%
==========================================
Files 116 116
Lines 7217 7217
==========================================
- Hits 3410 3409 -1
Misses 3540 3540
- Partials 267 268 +1
Continue to review full report at Codecov.
|
|
Please help check if the API doc change satisfies the corresponding pull request #1065 @yunfeiyanggzq . Thanks a lot. |
the swagger.yml only add "/api/v1" prefix before verrsion 1.0 url in #1065,this auto generated api doc does right.the doc changes a lot because the order is not the same as before @allencloud |
|
LGTM |
pouchrobot
added
the
LGTM
sungjunyoung
pushed a commit
to sungjunyoung/Dragonfly
that referenced
this pull request
May 8, 2022
Signed-off-by: Gaius <gaius.qi@gmail.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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
We use the following user input CLI document generating command in pouchrobot to generate CLI doc:
make build && make install && make 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.