-
Notifications
You must be signed in to change notification settings - Fork 14k
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
base: main
Are you sure you want to change the base?
Conversation
This pull request addresses inconsistent capitalization of prepositions on page "Windows in Kubernetes".
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
✅ Pull request preview available for checkingBuilt without sensitive environment variables
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/) |
There was a problem hiding this comment.
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!
There was a problem hiding this comment.
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:
- https://kubernetes.io/docs/concepts/security/windows-security/ - Security For (minor word should be lower case) Windows Nodes
- https://kubernetes.io/docs/concepts/policy/pid-limiting/ - Process ID Limits And (minor word should be lower case) Reservations
/assign dipesh-rawat
There was a problem hiding this comment.
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/)
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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:
-
Uppercase (All Caps): All letters are capitalized.
- Example: THIS IS AN EXAMPLE OF UPPERCASE TEXT.
-
Lowercase: All letters are in their lowercase form.
- Example: this is an example of lowercase text.
-
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.
-
Sentence Case: Only the first letter of the first word and proper nouns are capitalized.
- Example: This is an example of sentence case.
-
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.
-
Pascal Case: Similar to Camel Case, but the first letter of each word is capitalized.
- Example: ThisIsAnExampleOfPascalCase.
-
Snake Case: Words are separated by underscores, and typically all letters are lowercase.
- Example: this_is_an_example_of_snake_case.
-
Kebab Case: Words are separated by hyphens, and typically all letters are lowercase.
- Example: this-is-an-example-of-kebab-case.
-
Alternating Case: Letters alternate between uppercase and lowercase.
- Example: ThIs iS aN ExAmPlE Of aLtErNaTiNg cAsE.
-
Inverse Case: Lowercase letters are converted to uppercase and vice versa.
- Example: tHIS IS AN EXAMPLE OF INVERSE CASE.
/assign dipesh-rawat |
This pull request addresses inconsistent capitalization of prepositions on page "Windows in Kubernetes".