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 #1432

Merged
merged 1 commit into from
May 30, 2018
Merged

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

merged 1 commit into from
May 30, 2018

Conversation

pouchrobot
Copy link
Collaborator

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.

Signed-off-by: pouchrobot <pouch-dev@list.alibaba-inc.com>
@allencloud
Copy link
Collaborator

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label May 30, 2018
@allencloud allencloud merged commit d95d68c into AliyunContainerService:master May 30, 2018
@codecov-io
Copy link

Codecov Report

Merging #1432 into master will decrease coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1432      +/-   ##
==========================================
- Coverage   38.75%   38.74%   -0.02%     
==========================================
  Files         250      250              
  Lines       16621    16621              
==========================================
- Hits         6441     6439       -2     
  Misses       9354     9354              
- Partials      826      828       +2
Impacted Files Coverage Δ
ctrd/image.go 80.36% <0%> (-4.91%) ⬇️
daemon/mgr/container.go 49.35% <0%> (-0.26%) ⬇️
ctrd/container.go 48.06% <0%> (+0.77%) ⬆️
daemon/containerio/container_io.go 61.03% <0%> (+1.29%) ⬆️
main.go 60.13% <0%> (+2.09%) ⬆️
apis/server/utils.go 66.66% <0%> (+5.55%) ⬆️

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