Add karmadactl addons subcommand docs#172
Add karmadactl addons subcommand docs#172ONE7live wants to merge 2 commits intokarmada-io:mainfrom ONE7live:main
Conversation
|
Welcome @ONE7live! It looks like this is your first PR to karmada-io/website 🎉 |
Signed-off-by: ONE7live <wangqi_yewu@cmss.chinamobile.com>
|
/assign |
Yes, there could be an exclusive catalogue for |
|
@RainbowMango @lonelyCZ Can we give an example first? Then resolve it with a new Issue and PR. Because in my opinion, the complete karmadactl function documentation needs enough time to write, during which we still need to explain some functions (such as addons),what do y'all think? |
|
I want to get @Poor12's opinion. |
|
Maybe we can refer to https://kubernetes.io/docs/reference/kubectl/ about kubectl. We need a command guide for every subcommand and options(it's more like a generated thing). Also we need to provide some usage conventions about how to use it. |
karmada-io/karmada#2260 planed to import it, but we were going to import it when the cli more stable, what do you think? |
|
Thanks for reminding me. That's the approach to automatically generate the docs, not sure if we can customize the doc a little bit such as adding more examples. I'll look at it later. |
|
#176 move karmadactl manual to reference. Guess it's time to complete the karmadactl guide. I created three files to store karmadactl's options, subcommands and best practices. |
|
@ONE7live: Adding label DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Great, I'll resubmit a PR to refine it |

Signed-off-by: ONE7live wangqi_yewu@cmss.chinamobile.com
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Add karmadactl addons subcommand docs, refer to karmada-io/karmada#2134
Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: