Skip to content

Add karmadactl addons subcommand docs#172

Closed
ONE7live wants to merge 2 commits intokarmada-io:mainfrom
ONE7live:main
Closed

Add karmadactl addons subcommand docs#172
ONE7live wants to merge 2 commits intokarmada-io:mainfrom
ONE7live:main

Conversation

@ONE7live
Copy link

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:

@karmada-bot karmada-bot added the kind/documentation Categorizes issue or PR as related to documentation. label Sep 14, 2022
@karmada-bot
Copy link
Contributor

Welcome @ONE7live! It looks like this is your first PR to karmada-io/website 🎉

@karmada-bot karmada-bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 14, 2022
Signed-off-by: ONE7live <wangqi_yewu@cmss.chinamobile.com>
@RainbowMango
Copy link
Member

/assign

@RainbowMango
Copy link
Member

Thanks @ONE7live for doing this.

I'm thinking if we need a separate document for karmadactl functionality.
@lonelyCZ Any suggestions?

@lonelyCZ
Copy link
Member

I'm thinking if we need a separate document for karmadactl functionality.

Yes, there could be an exclusive catalogue for karmadactl to describe the necessary subcommands(not only options but also usage example).

@ONE7live
Copy link
Author

@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?

@lonelyCZ
Copy link
Member

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?

Don't need complete doc. We can add it one by one. Like
image

cc @RainbowMango

@RainbowMango
Copy link
Member

I want to get @Poor12's opinion.

@Poor12
Copy link
Member

Poor12 commented Sep 16, 2022

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.
In this case, we can move karmadactl directory to reference.

@RainbowMango
Copy link
Member

Yeah, I agree with @Poor12. CLI not used only by administrators.

So, please @Poor12 help to set up the initial page and make a room for addons.

@lonelyCZ
Copy link
Member

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

karmada-io/karmada#2260 planed to import it, but we were going to import it when the cli more stable, what do you think?

@RainbowMango
Copy link
Member

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.

@Poor12
Copy link
Member

Poor12 commented Sep 20, 2022

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

@karmada-bot karmada-bot added the do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. label Sep 23, 2022
@karmada-bot
Copy link
Contributor

@ONE7live: Adding label do-not-merge/contains-merge-commits because PR contains merge commits, which are not allowed in this repository.
Use git rebase to reapply your commits on top of the target branch. Detailed instructions for doing so can be found here.

Details

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

@karmada-bot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please ask for approval from rainbowmango after the PR has been reviewed.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ONE7live
Copy link
Author

Great, I'll resubmit a PR to refine it

@ONE7live ONE7live closed this Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge/contains-merge-commits Indicates a PR which contains merge commits. kind/documentation Categorizes issue or PR as related to documentation. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants