Skip to content

Improve kubectl introduction for clarity#55304

Open
sobit02 wants to merge 1 commit intokubernetes:mainfrom
sobit02:Improve-kubectl-into-clarity
Open

Improve kubectl introduction for clarity#55304
sobit02 wants to merge 1 commit intokubernetes:mainfrom
sobit02:Improve-kubectl-into-clarity

Conversation

@sobit02
Copy link
Copy Markdown

@sobit02 sobit02 commented Apr 9, 2026

What I did

  • Replaced informal wording with a clearer and more professional description

Why

  • Improves readability and helps users better understand kubectl's purpose

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Apr 9, 2026
@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 9, 2026
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 9, 2026

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 20f5f73
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/69da76b683f19d00086e2382
😎 Deploy Preview https://deploy-preview-55304--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@Caesarsage Caesarsage left a comment

Choose a reason for hiding this comment

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

Thanks for your PR. I think this is good for beginners. Left a few comments

@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 10, 2026

Thanks for the review and helpful suggestions!

I agree that using the glossary definition for the synopsis is better to avoid duplication. I’ll also update the introduction to use more active voice as suggested.

I’ll make these changes and push an update in a few hours.

@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 10, 2026

Thanks for the suggestions! I've updated the introduction to use active voice and replaced the synopsis with the
glossary definition. I also consolidated changes from the duplicate PR .

Copy link
Copy Markdown
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

Lgtm

@Caesarsage
Copy link
Copy Markdown
Contributor

Thanks, this look good.

can you help squash your commits.
you can check how here https://kubernetes.io/docs/contribute/new-content/open-a-pr/#squashing-commits

@sobit02 sobit02 force-pushed the Improve-kubectl-into-clarity branch from 6a43c73 to a5584e5 Compare April 11, 2026 11:36
@k8s-ci-robot k8s-ci-robot added area/localization General issues or PRs related to localization language/zh Issues or PRs related to Chinese language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 11, 2026
@sobit02 sobit02 force-pushed the Improve-kubectl-into-clarity branch from a5584e5 to 7ec8654 Compare April 11, 2026 11:56
@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 11, 2026

Squashed the commits into a single commit and updated the PR. Please review and let me know if anything else is needed.

@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 11, 2026

Refined the JSONPath description to improve grammatical correctness and align with the existing documentation style.

@Caesarsage
Copy link
Copy Markdown
Contributor

Seems the PR now contains some unrelated changes. Kindly take a look at it. Thanks

@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 11, 2026

Thanks for pointing that out. I've removed the unrelated JSONPath changes and kept this PR focused on improving the kubectl introduction.

@sobit02 sobit02 force-pushed the Improve-kubectl-into-clarity branch from 41d41a7 to 20f5f73 Compare April 11, 2026 16:28
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[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 divya-mohan0209 for approval. For more information see the Code Review Process.

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

@k8s-ci-robot k8s-ci-robot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Apr 11, 2026
@sobit02
Copy link
Copy Markdown
Author

sobit02 commented Apr 11, 2026

Thanks for the feedback. I’ve rebased the branch on upstream/main and ensured the PR now only contains the intended changes to kubectl documentation.

@Caesarsage
Copy link
Copy Markdown
Contributor

/lgtm

Thank you

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 11, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: 112b4aa804aea7f07df3b1a6c67fd789f72f7fc1

@Caesarsage
Copy link
Copy Markdown
Contributor

/remove-language zh

@k8s-ci-robot k8s-ci-robot removed the language/zh Issues or PRs related to Chinese language label Apr 11, 2026
@Caesarsage
Copy link
Copy Markdown
Contributor

/remove-area localization

@k8s-ci-robot k8s-ci-robot removed the area/localization General issues or PRs related to localization label Apr 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants