Skip to content

fix(style): update namespaces.md to follow documentation style guide#56523

Open
prathamesh04 wants to merge 1 commit into
kubernetes:mainfrom
prathamesh04:fix/style-violations-namespaces-doc
Open

fix(style): update namespaces.md to follow documentation style guide#56523
prathamesh04 wants to merge 1 commit into
kubernetes:mainfrom
prathamesh04:fix/style-violations-namespaces-doc

Conversation

@prathamesh04

Copy link
Copy Markdown

What this PR does

This PR fixes multiple documentation style violations in content/en/docs/tasks/administer-cluster/namespaces.md to align with the Kubernetes documentation style guide.

Changes made

  • Replace 'we' with 'you' to address the reader directly as per style guide rules
  • Remove informal language like 'let's' and 'simple'
  • Replace 'cattle' metaphor with neutral terminology (related to issue docs: replace 'cattle vs. pets' metaphor with more precise terminology #54665)
  • Fix grammar: change 'can not' to 'cannot', expand contractions for formal writing
  • Improve clarity by rewriting sentences for better readability

Style guide violations fixed

Violation Before After
Using 'we' instead of 'you' "we will create" "you create"
Informal language "let's spin up" "create"
Cattle metaphor "Production likes to run cattle" "Create some pods in the production namespace"
Grammar "can not" "cannot"
Contractions "There's" "There is"

Verification

  • No remaining 'we' usage in the file
  • No remaining informal language
  • Headings use sentence case
  • All links are valid

Related issues

…tyle guide

- Replace 'we' with 'you' to address reader directly (style guide rule)
- Remove 'let's' and informal language
- Replace 'cattle' metaphor with neutral terminology
- Fix 'can not' to 'cannot'
- Expand 'There's' to 'There is' for formal writing
- Improve sentence structure for clarity

Follows the Kubernetes documentation style guide:
https://kubernetes.io/docs/contribute/style/style-guide/
@kubernetes-prow

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 kernel-kun 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

@kubernetes-prow
kubernetes-prow Bot requested a review from derekwaynecarr July 18, 2026 06:40
@kubernetes-prow kubernetes-prow Bot added the language/en Issues or PRs related to English language label Jul 18, 2026
@kubernetes-prow
kubernetes-prow Bot requested a review from janetkuo July 18, 2026 06:40
@kubernetes-prow kubernetes-prow Bot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 18, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

Welcome @prathamesh04!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@kubernetes-prow kubernetes-prow Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jul 18, 2026
@netlify

netlify Bot commented Jul 18, 2026

Copy link
Copy Markdown

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 63dcf34
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-main-staging/deploys/6a5b1fe2c79fba0008567930
😎 Deploy Preview https://deploy-preview-56523--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.

@lmktfy lmktfy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks.

/lgtm

[DNS label](/docs/concepts/overview/working-with-objects/names#dns-label-names).

There's an optional field `finalizers`, which allows observables to purge resources whenever the
There is an optional field `finalizers`, which allows observables to purge resources whenever the

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The original is more idiomatic.

@kubernetes-prow kubernetes-prow Bot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jul 18, 2026
@kubernetes-prow

Copy link
Copy Markdown
Contributor

LGTM label has been added.

DetailsGit tree hash: f905c2ccf139b83b4b66cdaad231fd21f937dc7a

@lmktfy

lmktfy commented Jul 18, 2026

Copy link
Copy Markdown
Member

Did you use AI help for this PR @prathamesh04 ?

If you did, you must say so.

@prathamesh04

Copy link
Copy Markdown
Author

Hi! @lmktfy Yes, I used AI assistance (GitHub Copilot) for drafting the style edits. The changes were reviewed and verified by me against the Kubernetes style guide.

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. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants