Skip to content

Conversation

@abhishek-8081
Copy link
Contributor

@abhishek-8081 abhishek-8081 commented Aug 4, 2025

This pull request addresses [Issue #2144](openkruise/kruise#2144) by adding a dedicated CLI reference page for the kubectl kruise plugin.

What’s Added:

  • Created a new documentation file: docs/user-manuals/cli-reference.md

  • Documented:

    • Global flags like --namespace, --kubeconfig, etc.
    • Subcommands including rollout, set image, get, deleteprotection, and more
    • Available flags and options for each subcommand
    • Example commands for common use cases

Why This is Useful:

  • Consolidates all CLI commands in a single, discoverable page
  • Helps new users explore features without searching multiple pages
  • Aligns with documentation practices used in Kubernetes, Helm, and Argo CD
  • Makes it easier to maintain and extend CLI documentation in the future

Please let me know if any improvements are needed. Happy to make changes!

@kruise-bot kruise-bot requested review from ls-2018 and zmberg August 4, 2025 11:15
@kruise-bot
Copy link

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign chrisliu1995 for approval by writing /assign @chrisliu1995 in a comment. For more information see:The Kubernetes Code Review Process.

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

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

@abhishek-8081 abhishek-8081 changed the title Cli reference addition docs: Add dedicated CLI reference page for kubectl kruise (#2144) Aug 4, 2025
@abhishek-8081 abhishek-8081 force-pushed the cli-reference-addition branch from a036628 to 95dc579 Compare August 4, 2025 11:19
@kruise-bot kruise-bot added size/XXL and removed size/L labels Aug 4, 2025
@abhishek-8081 abhishek-8081 force-pushed the cli-reference-addition branch 2 times, most recently from 31ecf62 to 675aeaa Compare August 4, 2025 20:33
- Fix 'Install OpenKruise' link to point to installation guide
- Fix 'Architecture' link to point to architecture documentation

Fixes openkruise#272

Signed-off-by: Abhishek Kumar <[email protected]>
Signed-off-by: Abhishek Kumar <[email protected]>
@abhishek-8081 abhishek-8081 force-pushed the cli-reference-addition branch from 675aeaa to 2fb63c7 Compare August 4, 2025 20:34
Copy link
Member

@furykerry furykerry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is already a doc for cli tool, can you update that doc instead ?

@abhishek-8081
Copy link
Contributor Author

Thank you for the feedback. I'll create a new PR updating the existing cli-tool doc instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants