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

Enhancement By: Renaming 'ReadMes' to 'README' for Improved Clarity. #42982

Merged
merged 3 commits into from
Sep 15, 2023
Merged

Enhancement By: Renaming 'ReadMes' to 'README' for Improved Clarity. #42982

merged 3 commits into from
Sep 15, 2023

Conversation

Rituraj-13
Copy link
Contributor

@Rituraj-13 Rituraj-13 commented Sep 10, 2023

Fixes issue - #42979

Made the required changes in README.md file .

image

  1. Updated Localization ReadMes to Localization READMEs.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Sep 10, 2023

CLA Signed

The committers listed above are authorized under a signed CLA.

@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Sep 10, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @Rituraj-13!

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

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Sep 10, 2023
@netlify
Copy link

netlify bot commented Sep 10, 2023

Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 754094a
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/650134244e5e2a0008405c26
😎 Deploy Preview https://deploy-preview-42982--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.

Copy link
Member

@aj11anuj aj11anuj left a comment

Choose a reason for hiding this comment

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

Localized README.md's seems more appropriate to me than Localization of README.md's

Btw, I'm kind of getting some Hacktoberfest feel now 👀

@Rituraj-13
Copy link
Contributor Author

Rituraj-13 commented Sep 10, 2023

Localized README.md's seems more appropriate to me than Localization of README.md's

Btw, I'm kind of getting some Hacktoberfest feel now 👀

I found Localization README.md to be inappropriate, and ReadMes also require correction.

@aj11anuj
Copy link
Member

Hello @Rituraj-13 brother, I appreciate your contribution, but maybe you got my words in wrong way. I mean Localized README.md's seems more appropriate to me not Localization ReadMe that was earlier. But Localization README.md's in some way of saying is also Ok-Ok. I don't know, if a minute change like this one will get accepted.

@windsonsea
Copy link
Member

/language en

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Sep 10, 2023
@Rituraj-13
Copy link
Contributor Author

Hello @Rituraj-13 brother, I appreciate your contribution, but maybe you got my words in wrong way. I mean Localized README.md's seems more appropriate to me not Localization ReadMe that was earlier. But Localization README.md's in some way of saying is also Ok-Ok. I don't know, if a minute change like this one will get accepted.

Thanks bro, for suggestions 👍
I made the required changes, have a look.

Copy link
Member

@sandipanpanda sandipanpanda left a comment

Choose a reason for hiding this comment

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

/lgtm
Thanks!

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

LGTM label has been added.

Git tree hash: 70394f8a8593032a9ebdd7a03bb22a55d41a75d3

README.md Outdated Show resolved Hide resolved
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 11, 2023
@windsonsea
Copy link
Member

windsonsea commented Sep 11, 2023

/lgtm

Need to trigger the CI again:

git reset
git commit --amend --no-edit
git push origin correct-grammar-typos -f

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

LGTM label has been added.

Git tree hash: 2313c756c55878d75b2f1376ed4e814ef99a9948

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 11, 2023
@Rituraj-13
Copy link
Contributor Author

/lgtm

Need to trigger the CI again:

git reset
git commit --amend --no-edit
git push origin correct-grammar-typos -f

Hey @windsonsea ,
I have made the changes, kindly have a look.
Thanks !

@windsonsea
Copy link
Member

Seems you run different command series and /lgtm is removed.

/label tide/merge-method-squash

@k8s-ci-robot k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 11, 2023
@Rituraj-13
Copy link
Contributor Author

Rituraj-13 commented Sep 11, 2023

Seems you run different command series and /lgtm is removed.

/label tide/merge-method-squash

Yeah, for some reason I couldn't make changes with those commands.
So I made a new commit.

So now, do I need to squash those 2 commits and again force push them ?

@windsonsea
Copy link
Member

/lgtm

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

LGTM label has been added.

Git tree hash: 2313c756c55878d75b2f1376ed4e814ef99a9948

@nate-double-u
Copy link
Contributor

nate-double-u commented Sep 12, 2023

I think "Localization" is likely correct in this instance as it is referring to specific localization teams.

"Localization ReadMes" could probably be corrected to "Localization READMEs", and I'd also suggest taking the "``" out of the title.

@nate-double-u
Copy link
Contributor

/area localization

@k8s-ci-robot k8s-ci-robot added the area/localization General issues or PRs related to localization label Sep 12, 2023
README.md Outdated
@@ -182,7 +182,7 @@ If you need help at any point when contributing, the [New Contributor Ambassador
| -------------------------- | -------------------------- | -------------------------- |
| Arsh Sharma | @arsh | @RinkiyaKeDad |

## Localization `README.md`'s
## Localized READMEs
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Localized READMEs
## Localization READMEs

README.md Outdated
@@ -5,7 +5,7 @@
This repository contains the assets required to build the [Kubernetes website and documentation](https://kubernetes.io/). We're glad that you want to contribute!

- [Contributing to the docs](#contributing-to-the-docs)
- [Localization ReadMes](#localization-readmemds)
- [Localized READMEs](#localized-readmemds)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [Localized READMEs](#localized-readmemds)
- [Localization READMEs](#localization-readmes)

@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 13, 2023
@Rituraj-13 Rituraj-13 changed the title Fixed typing and grammatical errors in README.md file. Enhancement By: Renaming 'ReadMes' to 'README' for Improved Clarity. Sep 13, 2023
@nate-double-u
Copy link
Contributor

nate-double-u commented Sep 13, 2023

/lgtm

If someone from the localization team agrees I think this can go in.

Thinking about it more, and not being able to read the majority of the localizations, if the non-english README pages are just a translation of this page, then “Localized README” is probably correct, but if there are region/language specific bits of content or info about the teams doing the localization, then the current “Localization READMEs” is probably correct.

But that’s a lot of thinking for a small change 😅 Probably this should go in, and if it needs to be updated again we should package it with a more robust review/edit of the page.

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

LGTM label has been added.

Git tree hash: 64456623f6293da0e131a45a3e68f7f6550f1efc

@tengqm
Copy link
Contributor

tengqm commented Sep 15, 2023

/label tide/merge-method-squash
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described 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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 15, 2023
@k8s-ci-robot k8s-ci-robot merged commit dfcff46 into kubernetes:main Sep 15, 2023
@Rituraj-13 Rituraj-13 deleted the correct-grammar-typos branch September 15, 2023 05:26
aj11anuj pushed a commit to aj11anuj/K8s-Website that referenced this pull request Sep 15, 2023
…ubernetes#42982)

* Fixed grammar and typo

* Updated README.md

* Changed Localized to Localization
@sftim
Copy link
Contributor

sftim commented Sep 18, 2023

A better title could have been: Reword 'ReadMes' to 'READMEs'

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/localization General issues or PRs related to localization 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. 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. tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants