website icon indicating copy to clipboard operation
website copied to clipboard

fix: correct invalid Gateway example in v1.1 docs

Open UgOrange opened this issue 8 months ago • 10 comments

Description

Corrects YAML formatting in the spec.listeners section of the Gateway API example.

Issue

Closes: #50222

UgOrange avatar Mar 25 '25 08:03 UgOrange

CLA Signed

The committers listed above are authorized under a signed CLA.

  • :white_check_mark: login: UgOrange / name: UgOrange (7ec23a886631c8c59c001bff9d1a880551d42130)

Welcome @UgOrange!

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. :smiley:

k8s-ci-robot avatar Mar 25 '25 08:03 k8s-ci-robot

Pull request preview available for checking

Built without sensitive environment variables

Name Link
Latest commit 7ec23a886631c8c59c001bff9d1a880551d42130
Latest deploy log https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/67e6b4b84d623a0008ffe8ed
Deploy Preview https://deploy-preview-50223--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.

netlify[bot] avatar Mar 25 '25 08:03 netlify[bot]

Typically we only do one language at a time, but since this is just updating non-translated code samples, I believe it is good to do in one PR.

/lgtm

stmcginnis avatar Mar 25 '25 12:03 stmcginnis

LGTM label has been added.

Git tree hash: 84dcf9babb4d5607b49fc8b388b6d12e25af80f4

k8s-ci-robot avatar Mar 25 '25 12:03 k8s-ci-robot

Typically we only do one language at a time, but since this is just updating non-translated code samples, I believe it is good to do in one PR.

/lgtm

The trouble is, it may still need 4 signoffs (one per language)

sftim avatar Mar 26 '25 11:03 sftim

Typically we only do one language at a time, but since this is just updating non-translated code samples, I believe it is good to do in one PR.

/lgtm

Em... maybe a little bit explanation would help understand why we don't do more than one language change in the same PR. Among the many possible reasons, I have a compelling one to share.

Members of the Chinese localization team, including me, track the upstream English version by checking its timestamp. When we see that an English page en/foo/bar.md (merged on Mar 26th) is newer than the Chinese version (merged on Mar 20th), we do a git diff to identify ALL CHANGES to the English version since Mar 20th. We need to synchronize ALL those changes to zh/foo/bar.md. We as a team only merge fully synch'ed pages to ensure that when zh/foo/bar.md is merged, ALL new changes to the English page are properly handled. If the en/foo/bar.md is newer than zh/foo/bar.md, the Chinese page is treated as "out-of-sync". We have scripts to quickly find out those pages and the new changes to them. Suppose, zh/foo/bar.md is now out-of-sync, the team will reject any PR to zh/foo/bar.md if it cannot prove that it contains all the necessary changes. In other words, partial sync will be strictly rejected. By maintaining this rule across the team, we never miss any changes to the English version.

I don't how other localization team maintains the up-to-date status for localized pages. At least from the Chinese localization team's perspective, changing the zh page along with the en page is always dangerous. We have to check it carefully in case that when such a partial sync is merged, we won't be able to easily tell what other changes could have been missing.

tengqm avatar Mar 26 '25 13:03 tengqm

Em... maybe a little bit explanation would help understand why we don't do more than one language change in the same PR. Among the many possible reasons, I have a compelling one to share.

Members of the Chinese localization team, including me, track the upstream English version by checking its timestamp. When we see that an English page en/foo/bar.md (merged on Mar 26th) is newer than the Chinese version (merged on Mar 20th), we do a git diff to identify ALL CHANGES to the English version since Mar 20th. We need to synchronize ALL those changes to zh/foo/bar.md. We as a team only merge fully synch'ed pages to ensure that when zh/foo/bar.md is merged, ALL new changes to the English page are properly handled. If the en/foo/bar.md is newer than zh/foo/bar.md, the Chinese page is treated as "out-of-sync". We have scripts to quickly find out those pages and the new changes to them. Suppose, zh/foo/bar.md is now out-of-sync, the team will reject any PR to zh/foo/bar.md if it cannot prove that it contains all the necessary changes. In other words, partial sync will be strictly rejected. By maintaining this rule across the team, we never miss any changes to the English version.

I don't how other localization team maintains the up-to-date status for localized pages. At least from the Chinese localization team's perspective, changing the zh page along with the en page is always dangerous. We have to check it carefully in case that when such a partial sync is merged, we won't be able to easily tell what other changes could have been missing.

I understand your concerns. I've modified the commit to only include changes to the English version of the document, and hope this won't cause any complications.

UgOrange avatar Mar 28 '25 14:03 UgOrange

/remove-language bn ja zh

tengqm avatar Mar 29 '25 05:03 tengqm

/approve

tengqm avatar Mar 29 '25 05:03 tengqm

[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 avatar Mar 29 '25 05:03 k8s-ci-robot

LGTM label has been added.

Git tree hash: bb9fc179a72ed8b34c179667ab081f258075a9a9

k8s-ci-robot avatar Apr 07 '25 10:04 k8s-ci-robot