Skip to content
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 #801

Merged
merged 1 commit into from
Aug 11, 2019

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
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.

@codecov-io
Copy link

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #801      +/-   ##
==========================================
- Coverage   39.25%   39.23%   -0.02%     
==========================================
  Files         108      108              
  Lines        6313     6313              
==========================================
- Hits         2478     2477       -1     
  Misses       3630     3630              
- Partials      205      206       +1
Impacted Files Coverage Δ
supernode/daemon/mgr/scheduler/manager.go 24.06% <0%> (-0.76%) ⬇️

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 7d06b94...e628f9b. Read the comment docs.

@allencloud
Copy link
Contributor

LGTM

@pouchrobot pouchrobot added the LGTM one maintainer or community participant agrees to merge the pull reuqest. label Aug 11, 2019
@allencloud allencloud merged commit 259a368 into dragonflyoss:master Aug 11, 2019
starnop pushed a commit to starnop/Dragonfly that referenced this pull request Nov 27, 2019
docs: auto generate Dragonfly cli/api/contributors docs via code
inoc603 pushed a commit to inoc603/Dragonfly that referenced this pull request Dec 23, 2019
docs: auto generate Dragonfly cli/api/contributors docs via code
sungjunyoung pushed a commit to sungjunyoung/Dragonfly that referenced this pull request May 8, 2022
* rename getdistance to getAffinity

Signed-off-by: 孙伟鹏 <[email protected]>

* CDN has the lowest priority among all peers with the same number of pieces

Signed-off-by: 孙伟鹏 <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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