Skip to content

[en] Update images.md to follow style guide recommendations #50774

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[en] Update images.md to follow style guide recommendations #50774

wants to merge 2 commits into from
+176 −150

Conversation

stormqueen1990
Copy link
Member

Description

While reviewing #50183, I noticed some missing punctuation in https://k8s.io/docs/concepts/containers/images, as well as some parts that were not following the recommendations described in the Kubernetes Documentation Style Guide. This PR aims to address these points.

Changes

The following changes were made to this page:

  • Updated punctuation to make it consistent across list items.
  • Updated wording of API types to use upper camel case.
  • Removed unnecessary phrases.
  • Included links to content within the same page.
  • Fixed grammar and typos in some sentences, including missing periods.
  • Updated placeholders to use angle brackets, as described in the style guide.
  • Updated the words Windows and Hyper-V to use the exact same spelling used in the product name.
  • Removed trailing whitespace.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language labels May 4, 2025
@k8s-ci-robot k8s-ci-robot requested review from lmktfy and thockin May 4, 2025 23:19
@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 4, 2025
@stormqueen1990 stormqueen1990 changed the title Update images.md to follow style guide recommendations [en] Update images.md to follow style guide recommendations May 4, 2025
@netlify Netlify
Copy link

netlify bot commented May 4, 2025

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 5270a15
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6817f5dbbb7a0500088d86f8
😎 Deploy Preview https://deploy-preview-50774--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.

windsonsea
windsonsea reviewed May 6, 2025
View reviewed changes
Copy link
Member

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

lgtm overall.

see preview:
https://deploy-preview-50774--kubernetes-io-main-staging.netlify.app/docs/concepts/containers/images/

lmktfy
lmktfy reviewed May 6, 2025
View reviewed changes
Copy link
Contributor

@lmktfy lmktfy left a comment

Choose a reason for hiding this comment

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

Thanks

/LGTM

Merging this would improve our documentation.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 6, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 84393b7e68e9319f8e1cf877cb297773259f0302

@stormqueen1990
Update images.md to follow style guide recommendations
cd00638 
Update page /docs/concepts/containers/images.md to follow
recommendations on the style guide of Kubernetes documentation:
* Make punctuation consistent across list items.
* Use upper camel case for API types.
* Remove unnecessary phrases.
* Include links to content within the same page.
* Fix small grammar and typos.
* Add missing periods in sentences.
* Use angle brackets in placeholders.
@stormqueen1990
Apply changes from code review
ff3c38c 
* Fix wording in some items.
* Add some tooltips.
* Add blurbs in topics useful for static Pods.
* Fix some Pod references to use upper camel case.
* Fix title to use sentence case.
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 8, 2025
@k8s-ci-robot k8s-ci-robot requested a review from lmktfy May 8, 2025 03:02
@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 ask for approval from lmktfy. For more information see the 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

@stormqueen1990
Copy link
Member Author

@windsonsea @lmktfy I applied all of your suggestions, could you please take another look? 😃

@stormqueen1990 stormqueen1990 requested a review from windsonsea May 8, 2025 03:04
windsonsea
windsonsea reviewed May 8, 2025
View reviewed changes
Copy link
Member

@windsonsea windsonsea left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 8, 2025
@k8s-ci-robot
Copy link
Contributor

LGTM label has been added.

Git tree hash: 237fe36cb4a340ae851a91e2469e0a85da8ad22c

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

@windsonsea windsonsea windsonsea left review comments

@thockin thockin Awaiting requested review from thockin

@lmktfy lmktfy Awaiting requested review from lmktfy

Assignees

@windsonsea windsonsea

@lmktfy lmktfy

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/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stormqueen1990 @k8s-ci-robot @windsonsea @lmktfy