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.

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

Update en/docs #45585

Merged
merged 1 commit into from Apr 30, 2024
Merged

Update en/docs #45585

merged 1 commit into from Apr 30, 2024

Conversation

HwangTaehyun
Copy link
Contributor

@HwangTaehyun HwangTaehyun commented Mar 18, 2024 •
edited

It is just giving an example string, but its readability could be improved if fixed.

@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Mar 18, 2024
@k8s-ci-robot k8s-ci-robot added the sig/docs Categorizes an issue or PR as relevant to SIG Docs. label Mar 18, 2024
@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Mar 18, 2024 •
edited

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: HwangTaehyun / name: Taehyun Hwang (04c5c84)

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Mar 18, 2024
@k8s-ci-robot
Copy link
Contributor

Welcome @HwangTaehyun!

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 the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Mar 18, 2024
@netlify Netlify
Copy link

netlify bot commented Mar 18, 2024 •
edited

✅ Pull request preview available for checking

Built without sensitive environment variables

Name Link
🔨 Latest commit 04c5c84
🔍 Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/6610fab14f0c6d000894f51b
😎 Deploy Preview https://deploy-preview-45585--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.

@stmcginnis
Copy link
Contributor

Hi @HwangTaehyun, can you sign the CLA? That will be required to accept any changes.

Are there any other changes needed in this file? I don't think this change actually needs to be made since it is just giving an example string. But if you wanted to change it along with some other needed fixes, I think that would be fine.

@AmarNathChary
Copy link
Contributor

/easycla

Arhell
Arhell reviewed Mar 19, 2024
View reviewed changes
Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

/easycla

@k8s-ci-robot k8s-ci-robot added 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 Mar 24, 2024
@HwangTaehyun
Copy link
Contributor Author

HwangTaehyun commented Mar 24, 2024 •
edited

@AmarNathChary @Arhell Thank you, I signed it!
@stmcginnis Yes, you're right. But its readability could be improved, so I'd like to fix it!
There aren't any other needed fixes right now.

@k8s-ci-robot k8s-ci-robot added language/es Issues or PRs related to Spanish language language/id Issues or PRs related to Indonesian language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/zh Issues or PRs related to Chinese language size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Apr 4, 2024
@HwangTaehyun
Copy link
Contributor Author

@stmcginnis Hi! I've updated all abcxzy to abcxyz!

@stmcginnis
Copy link
Contributor

Sorry, the policy is to only change one language at a time. Could you update the en docs only in this PR? Then the other translations can follow.

Some unnecessary reformatting is included, but also a lot of good improvements in markdown "correctness", so I'm happy with this once its scope is narrowed.

Thanks!

@k8s-ci-robot k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Apr 6, 2024
@HwangTaehyun HwangTaehyun changed the title Update common-labels.md Update en/docs Apr 6, 2024
@HwangTaehyun
Copy link
Contributor Author

@stmcginnis I've reflected!

@stmcginnis
Copy link
Contributor

/lgtm

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

LGTM label has been added.

Git tree hash: c1a38e4d66095fc39ebad5ef87e31f679b3ea013

@HwangTaehyun HwangTaehyun requested a review from Arhell April 8, 2024 13:28
@HwangTaehyun
Copy link
Contributor Author

@celestehorgan @divya-mohan0209 @Arhell Could you review this PR?

@electrocucaracha
Copy link
Contributor

/lgtm
/approve

@reylejano
Copy link
Member

/remove-language es
/remove-language id
/remove-language ja
/remove-language ko
/remove-language ru
/remove-language zh

@k8s-ci-robot k8s-ci-robot removed language/es Issues or PRs related to Spanish language language/id Issues or PRs related to Indonesian language language/ja Issues or PRs related to Japanese language language/ko Issues or PRs related to Korean language language/ru Issues or PRs related to Russian language language/zh Issues or PRs related to Chinese language labels Apr 10, 2024
@reylejano
Copy link
Member

reylejano commented Apr 10, 2024 •
edited

I don't see how this improves the docs
This PR proposes to change the example mysql-abcxzy to mysql-abcxyz for better readability as stated in the description
To me, the readability is the same

I can be convinced otherwise

@electrocucaracha
Copy link
Contributor

I don't see how this improves the docs This PR proposes to change the example mysql-abcxzy to mysql-abcxyz for better readability as stated in the description To me, the readability is the same

I can be convinced otherwise

Well, readability is arguably subjective, but this particular PR seems to be a first time contribution, so I expect to see more challenging contributions in the future that fixes and/or improves the documentation.

@HwangTaehyun
Copy link
Contributor Author

@celestehorgan @divya-mohan0209 @Arhell Hi!, Could you review this PR? Thanks!

sftim
sftim reviewed Apr 30, 2024
View reviewed changes
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

abcxyz is a metasyntactic value and may be more recognizable than abcxzy.

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: electrocucaracha, sftim

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 Apr 30, 2024
@k8s-ci-robot k8s-ci-robot merged commit add6a0a into kubernetes:main Apr 30, 2024
6 checks passed
@ydFu ydFu mentioned this pull request May 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sftim sftim sftim left review comments

@celestehorgan celestehorgan Awaiting requested review from celestehorgan

@divya-mohan0209 divya-mohan0209 Awaiting requested review from divya-mohan0209

@Arhell Arhell Awaiting requested review from Arhell

Assignees

@electrocucaracha electrocucaracha

@stmcginnis stmcginnis

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. 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/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@HwangTaehyun @k8s-ci-robot @stmcginnis @AmarNathChary @electrocucaracha @reylejano @sftim @Arhell