docs: fix typo in HTTPRoute reference docs#2137
Conversation
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>
|
Thanks for addressing this inconsistency. Upon review of the page, I see that it's not just Would you mind fixing all of them? One other note, in your change in [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>
|
Thanks for the feedback! I've addressed all the inconsistencies you mentioned: ✅ Fixed all section heading names to PascalCase for consistency:
✅ Updated all cross-reference links to use correct capitalization while keeping anchor fragments in lowercase (e.g., ✅ Fixed anchor link in authorization-policy.md to use lowercase All changes are ready for review! |
|
Thanks for taking another look at this. It appears that all of the names were updated correctly in the |
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>
Good catch, thanks! I've now applied the full standardization to all versions ( |
|
All of the casing looks good, and great catch finding the typo in 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: My preference would be to leave them plural (e.g.: If we append the word "resources", we should probably also run Prettier to clean up the markdown table whitespace. |
|
I'm a fan of e.g. |
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>
|
Sounds good, thanks both! I went with |
|
Thanks for taking the time polish this up @bezarsnba! There's one instance that's still singular and needs "resources" appended: |
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.