karmada
karmada copied to clipboard
[WIP]Add gen-docs scripts
Signed-off-by: Poor12 [email protected]
What type of PR is this? /kind feature
What this PR does / why we need it: This pr import gen-docs script to automatically generate documentation for karmadactl and karmada components based on cobra refer to https://github.com/kubernetes/kubernetes/tree/master/cmd/gendocs.
Our current cli tools are still in a rapid development stage, and these generated docs are not intended to be our user-facing documentation directly, but only for reference.
Which issue(s) this PR fixes: Fixes #
Special notes for your reviewer:
Does this PR introduce a user-facing change?: None
Codecov Report
Merging #2561 (6d5d8e8) into master (93817a9) will decrease coverage by
0.00%
. The diff coverage is26.95%
.
@@ Coverage Diff @@
## master #2561 +/- ##
==========================================
- Coverage 25.61% 25.61% -0.01%
==========================================
Files 184 187 +3
Lines 18513 18628 +115
==========================================
+ Hits 4742 4771 +29
- Misses 13425 13509 +84
- Partials 346 348 +2
Flag | Coverage Δ | |
---|---|---|
unittests | 25.61% <26.95%> (-0.01%) |
:arrow_down: |
Flags with carried forward coverage won't be shown. Click here to find out more.
Impacted Files | Coverage Δ | |
---|---|---|
cmd/gencomponentdocs/gen_component_docs.go | 0.00% <0.00%> (ø) |
|
pkg/karmadactl/apply.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/cordon.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/deinit.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/describe.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/exec.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/get.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/join.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/logs.go | 0.00% <ø> (ø) |
|
pkg/karmadactl/promote.go | 0.00% <ø> (ø) |
|
... and 8 more |
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.
/cc @RainbowMango @lonelyCZ You can see the effect by https://deploy-preview-206--karmada.netlify.app/docs/next/reference/karmadactl/karmadactl-commands/karmadactl_index. BTW, index page is generated by the long description of the command. Content of some commands still need to improve.
/assign
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: RainbowMango
The full list of commands accepted by this bot can be found here.
The pull request process is described here
- ~~OWNERS~~ [RainbowMango]
Approvers can indicate their approval by writing /approve
in a comment
Approvers can cancel approval by writing /approve cancel
in a comment