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.

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

docs: auto generate pouch cli/api docs via code #563

Merged
merged 1 commit into from
Jan 12, 2018
Merged

docs: auto generate pouch cli/api docs via code #563

merged 1 commit into from
Jan 12, 2018

Conversation

pouchrobot
Copy link
Collaborator

Signed-off-by: pouchrobot [email protected]

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.

@codecov-io
Copy link

Codecov Report

Merging #563 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #563   +/-   ##
=======================================
  Coverage   14.16%   14.16%           
=======================================
  Files          64       64           
  Lines        3226     3226           
=======================================
  Hits          457      457           
  Misses       2722     2722           
  Partials       47       47

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ee7eacc...d774549. Read the comment docs.

@allencloud
Copy link
Collaborator

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Jan 12, 2018
@allencloud allencloud merged commit 650636c into AliyunContainerService:master Jan 12, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
areas/docs LGTM one maintainer or community participant agrees to merge the pull reuqest. size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants