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/contributors docs via code #2893

Merged

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
We use the following user input CLI document generating command in pouchrobot to generate CLI doc:
go build -o /usr/bin/pouch ./cli; pouch gen-doc

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>
@codecov
Copy link

codecov bot commented Jun 5, 2019

Codecov Report

❗ No coverage uploaded for pull request head (auto-doc-2019-06-05@5761482). Click here to learn what that means.
The diff coverage is n/a.

@allencloud
Copy link
Collaborator

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Jun 5, 2019
@allencloud allencloud merged commit 9653c63 into AliyunContainerService:master Jun 5, 2019
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.

2 participants