Spelling (and make links accessible) #3615

jsoref · 2025-02-13T20:33:57Z

What type of PR is this?
/kind cleanup

What this PR does / why we need it:
This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at https://github.com/jsoref/gateway-api/actions/runs/13315074066#summary-37186971636

The action reports that the changes in this PR would make it happy: https://github.com/jsoref/gateway-api/actions/runs/13315074182#summary-37186971624

Which issue(s) this PR fixes:

The last series of commits address this accessibility complaint (see "Forbidden patterns 🙅 (6)" in https://github.com/jsoref/gateway-api/actions/runs/13315074066#summary-37186971636):

Do not use `(click) here` links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

Does this PR introduce a user-facing change?:

NONE

k8s-ci-robot · 2025-02-13T20:34:07Z

Hi @jsoref. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

jsoref · 2025-02-13T21:46:47Z

conformance/reports/v0.7.1/nginx-nginx-gateway-fabric/README.md

-|x|[v0.5.0](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v0.5.0)|x|[link](./v1.1.0-report.yaml)|
+|x|[v0.5.0](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v0.5.0)|x|[v0.5.0 report](./v0.5.0-report.yaml)|


This is notable, the link was bad...

jsoref · 2025-02-13T21:59:47Z

conformance/reports/v0.8.0/kumahq-kuma/README.md

-|x|[2.4.1](https://github.com/kumahq/kuma/releases/tag/2.4.1)|x|[link](./2.4.1-report.yaml)|
+|x|[2.4.1](https://github.com/kumahq/kuma/releases/tag/2.4.1)|x|[v2.4.1 report](./2.4.1-report.yaml)|


Fwiw, I'd be inclined to change the Implementation version to consistently use a v prefix, it's probably 1/3 without the v, but I decided that was too far out of scope to do here. (As is, I half expect to split the accessibility changes into a distinct PR.)

jsoref · 2025-02-13T22:00:47Z

conformance/reports/v0.8.1/projectcontour-contour/README.md

+|experimental|[v1.27.3](https://github.com/projectcontour/contour/releases/tag/v1.27.3)|x|[v1.27.3 report](./v1.27.3-report.yaml)|
+|experimental|[v1.27.4](https://github.com/projectcontour/contour/releases/tag/v1.27.4)|x|[v1.27.4 report](./experimental-v1.27.4-default-report.yaml)|


I'm aware that the file names sometimes hint at experimental, and sometimes don't, but the things clearly don't think we care about that specific detail.

jsoref · 2025-02-13T22:17:11Z

conformance/reports/v1.1.0/gke-gateway/README.md

+|standard|1.30.3-gke.1211000|gke-l7-global-external-managed|[v1.30.3 gxlb report](./standard-1.30.3-gxlb-report.yaml)|
+|standard|1.30.3-gke.1211000|gke-l7-regional-external-managed|[v1.30.3 rxlb report](./standard-1.30.3-rxlb-report.yaml)|
+|standard|1.30.3-gke.1211000|gke-l7-rilb|[v1.30.3 rilb report](./standard-1.30.3-rilb-report.yaml)|


I've generally avoided adding any additional words beyond report, but as these are actually distinct reports, it's really important for accessibility agents to be able to distinguish them.

jsoref · 2025-02-13T22:17:18Z

conformance/reports/v1.2.0/kong-gateway-operator/README.md

@@ -4,7 +4,7 @@

 | API channel  | Implementation version                                                              | Mode        | Report                                                |
 |--------------|-------------------------------------------------------------------------------------|-------------|-------------------------------------------------------|
-| standard | [v1.4.0](https://github.com/Kong/gateway-operator/releases/tag/v1.4.0) | expressions | [link](./standard-v1.4.0-expressions-report.yaml) |
+| standard | [v1.4.0](https://github.com/Kong/gateway-operator/releases/tag/v1.4.0) | expressions | [v1.4.0 expressions report](./standard-v1.4.0-expressions-report.yaml) |


I've generally avoided including things other than report in the link title, but it feels like expressions is significantly different from the default report.

jsoref · 2025-02-13T22:18:20Z

geps/gep-1897/index.md

@@ -195,7 +195,7 @@ other signal that makes the failure sufficiently clear to the requester without
 based on established security requirements.

 All policy resources must include `TargetRefs` with the fields specified
-[here](https://github.com/kubernetes-sigs/gateway-api/blob/a33a934af9ec6997b34fd9b00d2ecd13d143e48b/apis/v1alpha2/policy_types.go#L24-L41).
+in [PolicyTargetReference](https://github.com/kubernetes-sigs/gateway-api/blob/a33a934af9ec6997b34fd9b00d2ecd13d143e48b/apis/v1alpha2/policy_types.go#L24-L41).


Picking names for things is hard, it's possible someone will have a better suggestion...

jsoref · 2025-02-13T22:19:18Z

site-src/concepts/tooling.md

@@ -6,18 +6,18 @@ Gateway API has tooling to facilitate interacting with the resources.

 Interested in seeing what your ingress resources will look like in Gateway API? `ingress2gateway` provides an easy manner to translate provider-specific resources to Gateway API resources. Managed by the Gateway API SIG-Network subproject.

-Get started [here](https://github.com/kubernetes-sigs/ingress2gateway?tab=readme-ov-file#installation)!
+Get started with [kubernetes-sigs/ingress2gateway: installation](https://github.com/kubernetes-sigs/ingress2gateway?tab=readme-ov-file#installation)!


I've added : installation to distinguish from the cases where links are to the general readme...

jsoref · 2025-02-13T22:19:56Z

site-src/concepts/tooling.md


 ## Third-Party Tooling

 ### `policy-machinery`

 Machinery for implementing Gateway API policies and policy controllers.

-Get started [here](https://github.com/Kuadrant/policy-machinery/tree/main)
+Get started with [Kuadrant/policy-machinery](https://github.com/Kuadrant/policy-machinery/tree/main)


Normally, this would be a link to https://github.com/Kuadrant/policy-machinery or https://github.com/Kuadrant/policy-machinery/, I'm not sure why someone included /tree/main, but it's outside the scope of this PR.

cc @guicassolato

jsoref · 2025-02-13T22:20:26Z

site-src/guides/migrating-from-ingress.md

@@ -251,7 +251,7 @@ In contrast, Gateway API specifies how to merge rules and resolve conflicts:
 * A Gateway implementation must merge the routing rules from all HTTPRoutes
  attached to a listener.
 * Conflicts must be handled as
-  prescribed [here](/concepts/guidelines/#conflicts). For example, more specific
+  prescribed in [API Design Guide: Conflicts](/guides/api-design/#conflicts). For example, more specific


The link appeared to redirect, so I've updated it, and then tried to pick a title based on the resolved page...

jsoref · 2025-02-21T21:46:03Z

geps/gep-1651/index.md

-((See status definitions [here](/geps/overview/#gep-states).)
+(See [status definitions](/geps/overview/#gep-states).)


The stray ( is notable

jsoref · 2025-02-21T21:46:20Z

geps/gep-1713/index.md

-((See status definitions [here](/geps/overview/#gep-states).)
+(See [status definitions](/geps/overview/#gep-states).)


jsoref · 2025-02-21T21:46:30Z

geps/gep-1742/index.md

-((See status definitions [here](/geps/overview/#gep-states).)
+(See [status definitions](/geps/overview/#gep-states).)


jsoref · 2025-02-21T21:46:37Z

geps/gep-2659/index.md

-((See status definitions [here](/geps/overview/#gep-states).)
+(See [status definitions](/geps/overview/#gep-states).)


jsoref · 2025-02-21T21:46:50Z

geps/gep-1911/index.md

-((See status definitions [here](/geps/overview/#gep-states).)
+(See [status definitions](/geps/overview/#gep-states).)


youngnick · 2025-02-26T06:38:07Z

conformance/reports/v0.7.1/cilium/README.md

@@ -4,6 +4,6 @@

 |API channel|Implementation version|Mode|Report|
 |-----------|----------------------|----|------|
-|x|[v1.14.0](https://github.com/cilium/cilium/releases/tag/v1.14.0)|x|[link](./v1.14.0-report.yaml)|
+|x|[v1.14.0](https://github.com/cilium/cilium/releases/tag/v1.14.0)|x|[v1.14.0 report](./v1.14.0-report.yaml)|


In all of these cases, these are submitted via PR, so we'll need to be diligent in checking new versions contain text other than link here, I guess.

Yes, do see #3615 (comment)

youngnick · 2025-02-26T06:41:52Z

This looks fine to me, thanks for this work @jsoref.

/approve

k8s-ci-robot · 2025-02-26T06:41:59Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jsoref, youngnick

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:

~~OWNERS~~ [youngnick]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

youngnick · 2025-02-26T06:42:57Z

/ok-to-test

jsoref · 2025-02-26T12:55:58Z

conformance/reports/README.md

@@ -62,7 +62,7 @@ is structured as follows:
  needs to add information in the "reproduce" section (see below) on how to configure
  such a mode.
 - **Report**: the link to the related report. It MUST be in the form of
-  `[link](./report.yaml)`. The reports must be named according to the following
+  `[_version_ report](./report.yaml)`. The reports must be named according to the following


This changes the instructions which should help with future pull requests, but, indeed a linter is necessary.

I'm, of course, using one, and if people like the results, I'm happy to talk with them about it, but it's outside the scope of this PR.

yeah, this is great, thanks.

Signed-off-by: Josh Soref <[email protected]>

jsoref · 2025-03-05T04:05:52Z

@youngnick what do i need to do to get this moving?

robscott

Thanks @jsoref! Lots of great improvements here.

/lgtm

robscott · 2025-03-05T17:01:13Z

site-src/concepts/tooling.md


 ## Third-Party Tooling

 ### `policy-machinery`

 Machinery for implementing Gateway API policies and policy controllers.

-Get started [here](https://github.com/Kuadrant/policy-machinery/tree/main)
+Get started with [Kuadrant/policy-machinery](https://github.com/Kuadrant/policy-machinery/tree/main)


cc @guicassolato

robscott · 2025-03-05T17:33:29Z

/hold cancel

k8s-ci-robot requested review from arkodg and kflynn February 13, 2025 20:34

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Feb 13, 2025

jsoref commented Feb 13, 2025

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 21, 2025

jsoref force-pushed the spelling branch from 304b45f to b0a7bcf Compare February 21, 2025 21:45

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 21, 2025

jsoref commented Feb 21, 2025

View reviewed changes

youngnick reviewed Feb 26, 2025

View reviewed changes

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 26, 2025

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Feb 26, 2025

jsoref commented Feb 26, 2025

View reviewed changes

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 5, 2025

jsoref added 6 commits March 4, 2025 22:42

spelling: case-sensitive

4284ba2

Signed-off-by: Josh Soref <[email protected]>

spelling: coalesce

37a8d38

Signed-off-by: Josh Soref <[email protected]>

spelling: connect

e2b7008

Signed-off-by: Josh Soref <[email protected]>

spelling: github

3d312c6

Signed-off-by: Josh Soref <[email protected]>

spelling: health checks

4d04452

Signed-off-by: Josh Soref <[email protected]>

spelling: hierarchy

b7fe69c

Signed-off-by: Josh Soref <[email protected]>

jsoref added 20 commits March 4, 2025 23:04

link: v1.15.0-pre.3 report

6aaf8cd

Signed-off-by: Josh Soref <[email protected]>

link: v1.27.0 report

c52774a

Signed-off-by: Josh Soref <[email protected]>

link: v1.27.1 report

bb15f16

Signed-off-by: Josh Soref <[email protected]>

link: v1.27.2 report

d13e722

Signed-off-by: Josh Soref <[email protected]>

link: v1.27.3 report

176c2a1

Signed-off-by: Josh Soref <[email protected]>

link: v1.27.4 report

4f4df69

Signed-off-by: Josh Soref <[email protected]>

link: v1.0.0 report

1e85bad

Signed-off-by: Josh Soref <[email protected]>

link: v2.12.0 report

31f72bd

Signed-off-by: Josh Soref <[email protected]>

link: v1.15.0-pre.1 report

5937f6a

Signed-off-by: Josh Soref <[email protected]>

link: v1.26.0 report

f8e1b03

Signed-off-by: Josh Soref <[email protected]>

link: v0.6.0 report

790875e

Signed-off-by: Josh Soref <[email protected]>

link: v2.4.1 report

5935919

Signed-off-by: Josh Soref <[email protected]>

link: latest report

0019750

Signed-off-by: Josh Soref <[email protected]>

link: f6c112e report

1946ce0

Signed-off-by: Josh Soref <[email protected]>

link: v0.5.0 report (and fix link!)

d6ccadc

Signed-off-by: Josh Soref <[email protected]>

link: v0.0.0-preview.vcf063c043 report

78c5df0

Signed-off-by: Josh Soref <[email protected]>

link: v2.10.3 report

c09dfac

Signed-off-by: Josh Soref <[email protected]>

link: PR #46148 report

ff2af48

Signed-off-by: Josh Soref <[email protected]>

link: v1.14.0 report

cbea5db

Signed-off-by: Josh Soref <[email protected]>

link: _version_ report

b4d82ed

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the spelling branch from b0a7bcf to b4d82ed Compare March 5, 2025 04:05

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 5, 2025

robscott reviewed Mar 5, 2025

View reviewed changes

k8s-ci-robot assigned robscott Mar 5, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Mar 5, 2025

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Mar 5, 2025

k8s-ci-robot merged commit d62f3bd into kubernetes-sigs:main Mar 5, 2025
13 checks passed

jsoref deleted the spelling branch March 5, 2025 18:14

		\|x\|[v0.5.0](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v0.5.0)\|x\|[link](./v1.1.0-report.yaml)\|
		\|x\|[v0.5.0](https://github.com/nginx/nginx-gateway-fabric/releases/tag/v0.5.0)\|x\|[v0.5.0 report](./v0.5.0-report.yaml)\|

		\|x\|[2.4.1](https://github.com/kumahq/kuma/releases/tag/2.4.1)\|x\|[link](./2.4.1-report.yaml)\|
		\|x\|[2.4.1](https://github.com/kumahq/kuma/releases/tag/2.4.1)\|x\|[v2.4.1 report](./2.4.1-report.yaml)\|

		\|experimental\|[v1.27.3](https://github.com/projectcontour/contour/releases/tag/v1.27.3)\|x\|[v1.27.3 report](./v1.27.3-report.yaml)\|
		\|experimental\|[v1.27.4](https://github.com/projectcontour/contour/releases/tag/v1.27.4)\|x\|[v1.27.4 report](./experimental-v1.27.4-default-report.yaml)\|

		((See status definitions [here](/geps/overview/#gep-states).)
		(See [status definitions](/geps/overview/#gep-states).)

Spelling (and make links accessible) #3615

Spelling (and make links accessible) #3615

Uh oh!

Conversation

jsoref commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Do not use (click) here links

Uh oh!

k8s-ci-robot commented Feb 13, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

youngnick commented Feb 26, 2025

Uh oh!

k8s-ci-robot commented Feb 26, 2025

Uh oh!

youngnick commented Feb 26, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsoref commented Mar 5, 2025

Uh oh!

robscott left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

robscott commented Mar 5, 2025

Uh oh!

Uh oh!

Uh oh!

jsoref commented Feb 13, 2025 •

edited

Loading

Do not use `(click) here` links