search

dragonflyoss / Dragonfly

This repository has be archived and moved to the new repository https://github.com/dragonflyoss/Dragonfly2.
https://d7y.io
Apache License 2.0
6k stars 774 forks source link

docs: auto generate Dragonfly cli/api/contributors docs via code #1491

Open pouchrobot opened 3 years ago

pouchrobot commented 3 years ago

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.

codecov-commenter commented 3 years ago

Codecov Report

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

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1491      +/-   ##
==========================================
+ Coverage   49.30%   49.31%   +0.01%     
==========================================
  Files         145      145              
  Lines        8380     8380              
==========================================
+ Hits         4132     4133       +1     
  Misses       3860     3860              
+ Partials      388      387       -1
Impacted Files Coverage Δ
supernode/daemon/mgr/scheduler/manager.go 20.00% <0.00%> (+0.76%) :arrow_up:

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 a928c0d...29d61ab. Read the comment docs.