Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Normalize Preposition Capitalization for Uniformity #46395

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

axpraka
Copy link

@axpraka axpraka commented May 16, 2024

This pull request addresses inconsistent capitalization of prepositions on page "Windows in Kubernetes".

This pull request addresses inconsistent capitalization of prepositions on page "Windows in Kubernetes".
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. language/en Issues or PRs related to English language labels May 16, 2024
@k8s-ci-robot
Copy link
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 dipesh-rawat for approval. 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

@k8s-ci-robot k8s-ci-robot requested a review from tengqm May 16, 2024 00:52
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label May 16, 2024
Copy link

netlify bot commented May 16, 2024

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit dfadcb3
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/664558b30d5268000852a7d4
😎 Deploy Preview https://deploy-preview-46395--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 site configuration.

* [Configure Group Managed Service Accounts for Windows Pods and Containers](/docs/tasks/configure-pod-container/configure-gmsa/)
* [Security For Windows Nodes](/docs/concepts/security/windows-security/)
* [Security for Windows Nodes](/docs/concepts/security/windows-security/)
Copy link
Contributor

Choose a reason for hiding this comment

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

Here's a problem: the title of https://kubernetes.io/docs/concepts/security/windows-security/ really is “Security For Windows Nodes” (which is following our style guide).

We usually shouldn't change existing links to use a different case convention than the actual title of the link target.

I'd edit https://kubernetes.io/docs/tasks/configure-pod-container/create-hostprocess-pod/ to use title case (all words capitalized) for its title. That way, you can keep the existing text and not have a discrepancy.


You could revise the style guide, too, but that's a bigger change!

Copy link
Author

Choose a reason for hiding this comment

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

sftim: Thanks for your feedback.

As per title case

"When using title case, all words are capitalized, except for minor words (typically articles, short prepositions, and some conjunctions) that are not the first or last word of the title."

I was considering changing title case for page https://kubernetes.io/docs/concepts/security/windows-security/. However, I wanted to begin with XS PR.

In my opinion, title case for page https://kubernetes.io/docs/tasks/configure-pod-container/create-hostprocess-pod/ ('Create a Windows HostProcess Pod') is accurate and doesn't need any modification. But below page titles(few examples) should be updated for case:

/assign dipesh-rawat

Copy link
Contributor

@sftim sftim May 16, 2024

Choose a reason for hiding this comment

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

I looked at https://kubernetes.io/docs/concepts/policy/pid-limiting/

The title of that page has “And” in upper case; again, that matches our style guide's advice on titles. The style guide could be more clear but please be very wary of making the link text be different from the title of the target page. It's easier for maintainers when the link text is either obviously different from the title:

learn about [limits on process ID use within pods](/docs/concepts/policy/pid-limiting/)

or identical:

For more detail, read [Process ID Limits And Reservations](https://kubernetes.io/docs/concepts/policy/pid-limiting/)

Copy link
Author

Choose a reason for hiding this comment

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

I have reviewed the page https://kubernetes.io/docs/contribute/style/style-guide/#headings.

  • Do: Use title case for the page title in the front matter. For example, title: Kubernetes API Server Bypass Risks
  • Don't: Use sentence case for page titles in the front matter. For example, don't use title: Kubernetes API server bypass risks

I agree with title case for the page title. And title case means:

"When using title case, all words are capitalized, except for minor words" Ref: title case

This PR is to update minor word case and hence following title case & the style guide.

Copy link
Author

Choose a reason for hiding this comment

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

Common types of text cases with examples:

  1. Uppercase (All Caps): All letters are capitalized.

    • Example: THIS IS AN EXAMPLE OF UPPERCASE TEXT.
  2. Lowercase: All letters are in their lowercase form.

    • Example: this is an example of lowercase text.
  3. Title Case: The first letter of each major word is capitalized. Minor words (like "and", "in", "on") are usually not capitalized unless they start the title.

    • Example: This Is an Example of Title Case.
  4. Sentence Case: Only the first letter of the first word and proper nouns are capitalized.

    • Example: This is an example of sentence case.
  5. Camel Case: The first letter of the first word is lowercase, and the first letter of each subsequent word is capitalized, with no spaces.

    • Example: thisIsAnExampleOfCamelCase.
  6. Pascal Case: Similar to Camel Case, but the first letter of each word is capitalized.

    • Example: ThisIsAnExampleOfPascalCase.
  7. Snake Case: Words are separated by underscores, and typically all letters are lowercase.

    • Example: this_is_an_example_of_snake_case.
  8. Kebab Case: Words are separated by hyphens, and typically all letters are lowercase.

    • Example: this-is-an-example-of-kebab-case.
  9. Alternating Case: Letters alternate between uppercase and lowercase.

    • Example: ThIs iS aN ExAmPlE Of aLtErNaTiNg cAsE.
  10. Inverse Case: Lowercase letters are converted to uppercase and vice versa.

    • Example: tHIS IS AN EXAMPLE OF INVERSE CASE.

@axpraka
Copy link
Author

axpraka commented May 16, 2024

/assign dipesh-rawat

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

None yet

3 participants