Skip to content

docs: drop teletype style for CompositePodGroup API kinds - #56912

Open
locker95 wants to merge 2 commits into
kubernetes:dev-1.37from
locker95:docs/style-compositepodgroup-backticks
Open

docs: drop teletype style for CompositePodGroup API kinds#56912
locker95 wants to merge 2 commits into
kubernetes:dev-1.37from
locker95:docs/style-compositepodgroup-backticks

Conversation

@locker95

@locker95 locker95 commented Aug 10, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Style guide says API kinds (CompositePodGroup, PodGroup, Workload, …) are written verbatim — no backticks. A bunch of the gang/PodGroup pages were wrapping those kind names in teletype.

Left field names (CompositePodGroupTemplate), plugins, and condition codes alone.

Targets dev-1.37.

Fixes #56893

This PR was written in part with the assistance of generative AI.

@kubernetes-prow kubernetes-prow Bot added this to the 1.37 milestone Aug 10, 2026
@kubernetes-prow kubernetes-prow Bot added the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Aug 10, 2026
@netlify

netlify Bot commented Aug 10, 2026 •
edited
Loading

Copy link
Copy Markdown

👷 Deploy Preview for kubernetes-io-vnext-staging processing.

Name Link
🔨 Latest commit 85f299a
🔍 Latest deploy log https://app.netlify.com/projects/kubernetes-io-vnext-staging/deploys/6a7ca6e2f43a0e000889ebe8

@kubernetes-prow kubernetes-prow Bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 10, 2026
@kubernetes-prow kubernetes-prow Bot added the language/en Issues or PRs related to English language label Aug 10, 2026
@kubernetes-prow

kubernetes-prow Bot commented Aug 10, 2026

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

@locker95
docs: backtick CompositePodGroup API names for style guide
45094e0 
Wrap remaining bare CompositePodGroup / CompositePodGroups mentions so
they match the API resource naming guidance.

Signed-off-by: Dean Chen <862469039@qq.com>
@locker95
locker95 force-pushed the docs/style-compositepodgroup-backticks branch from bf64ebe to 45094e0 Compare August 10, 2026 12:59
@kubernetes-prow kubernetes-prow Bot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label Aug 10, 2026
@netlify

netlify Bot commented Aug 10, 2026

Copy link
Copy Markdown

✅ Pull request preview available for checking

Built without sensitive environment variables

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

@netlify

netlify Bot commented Aug 10, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Pull request preview available for checking

Built without sensitive environment variables

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

@locker95
docs: drop teletype style for CompositePodGroup API kinds
85f299a 
Style guide: API kinds are written verbatim, not in backticks.
Leave field names, plugins, and condition codes in code style.

Kubernetes-issue: 56893

Signed-off-by: Dean Chen <862469039@qq.com>
@locker95 locker95 changed the title docs: backtick CompositePodGroup API names for style guide docs: drop teletype style for CompositePodGroup API kinds Aug 12, 2026
@kubernetes-prow kubernetes-prow Bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 12, 2026
@lmktfy

lmktfy commented Aug 12, 2026

Copy link
Copy Markdown
Member

This is AI generated, I'm guessing. To err is human, but this pattern of mistakes reminds me of a computer.

@locker95

locker95 commented Aug 12, 2026

Copy link
Copy Markdown
Contributor Author

yeah fair — i used generative AI to help draft some of the wording. i still checked it against the style guide myself; first push had the backticks the wrong way around, sorry about that. fixed it in the follow-up commit so kinds are plain text, not teletype.

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

Reviewers

@lmktfy lmktfy Awaiting requested review from lmktfy
@nate-double-u nate-double-u Awaiting requested review from nate-double-u

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Milestone

1.37

Development

Successfully merging this pull request may close these issues.

2 participants

@locker95 @lmktfy