Skip to content

docs: fix typo in HTTPRoute reference docs#2137

Open
bezarsnba wants to merge 6 commits into
linkerd:mainfrom
bezarsnba:fix-typy-httproute
Open

docs: fix typo in HTTPRoute reference docs#2137
bezarsnba wants to merge 6 commits into
linkerd:mainfrom
bezarsnba:fix-typy-httproute

Conversation

@bezarsnba

@bezarsnba bezarsnba commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Correct a typo in linkerd.io content/2-edge/reference/httproute.md to improve documentation clarity and accuracy.

This change fixes a spelling error in the HTTPRoute reference page for the 2-edge docs, ensuring the Linkerd documentation remains professional and easy to understand.

Correct a typo in linkerd.io content/2-edge/reference/httproute.md to keep the docs clear and accurate.

Signed-off-by: bezarsnba <bezarsnba@gmail.com>
@travisbeckham

Copy link
Copy Markdown
Collaborator

Thanks for addressing this inconsistency. Upon review of the page, I see that it's not just httpPathModfier that's inconsistent, but all of the other names too: httpRouteRule, httpRouteMatch, httpPathMatch, httpHeaderMatch, etc.

Would you mind fixing all of them?

One other note, in your change in authorization-policy.md‎ the anchor link should always be lowercase. For example:

[HTTPPathModifier](#HTTPPathModifier) -> [HTTPPathModifier](#httppathmodifier)

- Fix typo: httpPathModfier → HTTPPathModifier
- Standardize section headings to PascalCase (HTTPRouteRule, HTTPRouteMatch, etc.)
- Update cross-reference links and anchor fragments for consistency

Addresses PR linkerd#2137 review feedback.

Signed-off-by: bezarsnba <bezarsnba@gmail.com>
@bezarsnba

Copy link
Copy Markdown
Contributor Author

Thanks for the feedback! I've addressed all the inconsistencies you mentioned:

✅ Fixed all section heading names to PascalCase for consistency:

  • httpRouteRuleHTTPRouteRule
  • httpRouteMatchHTTPRouteMatch
  • httpPathMatchHTTPPathMatch
  • httpHeaderMatchHTTPHeaderMatch
  • httpRouteFilterHTTPRouteFilter
  • httpHeaderFilterHTTPHeaderFilter
  • httpRequestRedirectFilterHTTPRequestRedirectFilter
  • httpBackendRefHTTPBackendRef
  • httpRouteTimeoutsHTTPRouteTimeouts
  • And fixed the original typo: httpPathModfierHTTPPathModifier

✅ Updated all cross-reference links to use correct capitalization while keeping anchor fragments in lowercase (e.g., [HTTPPathModifier](#httppathmodifier))

✅ Fixed anchor link in authorization-policy.md to use lowercase

All changes are ready for review!

@travisbeckham

Copy link
Copy Markdown
Collaborator

Thanks for taking another look at this.

It appears that all of the names were updated correctly in the 2-edge version of reference/httproute.md (although I did not do an in-depth look yet), however, in all of the other versions, only HTTPPathModifier was fixed. Also in these other versions, there's an anchor link that's not lowercase ([HTTPPathModifier](#HTTPPathModifier))

Apply the same PascalCase heading and link-text standardization done in
2-edge to versions 2.13 through 2.19 and docs, keeping anchor fragments
lowercase. Also fix the missed httpQueryParamMatch heading in 2-edge and
the embedded HTTPRoute reference in the 2.12 authorization-policy page.

Signed-off-by: bezarsnba <bezarsnba@gmail.com>
@bezarsnba

Copy link
Copy Markdown
Contributor Author

Thanks for taking another look at this.

It appears that all of the names were updated correctly in the 2-edge version of reference/httproute.md (although I did not do an in-depth look yet), however, in all of the other versions, only HTTPPathModifier was fixed. Also in these other versions, there's an anchor link that's not lowercase ([HTTPPathModifier](#HTTPPathModifier))

Good catch, thanks! I've now applied the full standardization to all versions (2.132.19 and docs), not just 2-edge — headings in PascalCase, link texts updated, and all anchors lowercase. I also fixed the httpQueryParamMatch heading that was missed in 2-edge and standardized the embedded HTTPRoute section in 2.12/reference/authorization-policy.md. Ready for another review!

@travisbeckham

Copy link
Copy Markdown
Collaborator

All of the casing looks good, and great catch finding the typo in HTTPPathModifier.

The only concern I have is changing the resources names from plural to singular. I completely understand why you made this change, since the plural form is not the accurate name of the resource. However, "A list of HTTPRouteMatch." doesn't read very well.

Elsewhere in the docs we have handled it like: A list of [HTTPRouteMatch](#httproutematch)es, which I also don't like very much, since terminating an anchor link in the middle of a word seems like a typo.

My preference would be to leave them plural (e.g.: [HTTPRouteMatches](#httproutematch)), since we commonly pluralize these resources names in the content, such as "HTTPRoutes". Or, append the word "resources" whenever we're referring to a list (e.g.: A list of [HTTPRouteMatch](#httproutematch) resources). Either one is fine with me.

If we append the word "resources", we should probably also run Prettier to clean up the markdown table whitespace.

@kflynn

kflynn commented Jul 20, 2026

Copy link
Copy Markdown
Member

I'm a fan of e.g. A list of [HTTPRouteMatch](#httproutematch) resources), thank you! And thanks for sticking with this one. 🙂

Per PR review feedback, append "resources" to list-type field
descriptions (e.g. "A list of [HTTPRouteMatch](#httproutematch)
resources") instead of the bare singular type name, and realign
markdown table whitespace accordingly.

Signed-off-by: bezarsnba <bezarsnba@gmail.com>
@bezarsnba

Copy link
Copy Markdown
Contributor Author

Sounds good, thanks both! I went with A list of [...] resources across all versions (2.12-2.19, docs, 2-edge) and re-aligned the markdown table whitespace to match. Ready for another look.

@travisbeckham

Copy link
Copy Markdown
Collaborator

Thanks for taking the time polish this up @bezarsnba!

There's one instance that's still singular and needs "resources" appended: An array of [HTTPBackendRef](#httpbackendref) to declare...An array of [HTTPBackendRef](#httpbackendref) resources to declare..., but after that, it looks good to merge.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants