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.

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

Rework Gateway API, HTTPRoute, and GRPCRoute docs #1909

Merged
merged 14 commits into from
Jan 17, 2025
Merged

Conversation

wmorgan
Copy link
Member

@wmorgan wmorgan commented Jan 13, 2025

Here's my attempt at reflecting the modern world of Linkerd. (Note: these are all in the 2.17/ subfolder; once we're good on content we should also just copy these over to 2-edge.)

Summary:

  • Remove the top-level HTTPRoute feature doc. Replace it with a "Gateway API" feature doc
    • This doc includes instructions for how to have another project own the GW API on your cluster
    • This doc includes the version compatibility matrix
  • Remove all language suggesting that users use the policy.linkerd.io types, and instead note that they are supported but deprecated
  • Ensure all ServiceProfile docs (feature, ref, and guide) have a note that GW API types are now preferred, at the top
  • Add a new GRPCRoute reference doc
  • Make the HTTPRoute and (new) GRPCRoute reference docs point to the corresponding official docs for these types, and describe these docs as supplementary

Please review for technical accuracy as well as completeness. Note that the goal is to provide a practical guide to using the GW API types with Linkerd, not a comprehensive treatment of the GW API. Feedback welcome

Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
@wmorgan wmorgan requested review from kflynn, travisbeckham and a team January 13, 2025 17:36
Signed-off-by: William Morgan <[email protected]>
linkerd.io/content/2.17/reference/grpcroute.md Outdated Show resolved Hide resolved
linkerd.io/content/2.17/reference/httproute.md Outdated Show resolved Hide resolved
linkerd.io/content/2.17/reference/httproute.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@travisbeckham travisbeckham left a comment

Choose a reason for hiding this comment

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

The changes look good. Now that markdownlint is passing, htmltest is showing some failed links. There are several places in the docs that link tofeatures/httproute/ which was removed in this PR. Do these need to be updated tofeatures/gateway-api/?

Signed-off-by: William Morgan <[email protected]>
@wmorgan
Copy link
Member Author

wmorgan commented Jan 16, 2025

I fixed the broken links. In doing that I also cleaned up those docs, which expanded the scope of this PR quite a bit. We had a couple "tasks" docs that were very low-effort, which I removed entirely and put the content in the feature doc. I cleaned up a few other stylistic things like excessive hyperlinking.

Copy link
Member

@kflynn kflynn left a comment

Choose a reason for hiding this comment

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

I like this so far, many thanks!! 🙂

Signed-off-by: William Morgan <[email protected]>
Copy link
Collaborator

@travisbeckham travisbeckham left a comment

Choose a reason for hiding this comment

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

Looks good, although your latest cleanup resulted in more broken links.

Signed-off-by: William Morgan <[email protected]>
@wmorgan
Copy link
Member Author

wmorgan commented Jan 17, 2025

Ok, I think I have finally made the linters happy. @travisbeckham should I also copy these changes over to /2-edge/ ? I think they are also applicable to 2.16, should I copy them to that subtree as well?

Signed-off-by: William Morgan <[email protected]>
@travisbeckham
Copy link
Collaborator

Ok, I think I have finally made the linters happy. @travisbeckham should I also copy these changes over to /2-edge/ ? I think they are also applicable to 2.16, should I copy them to that subtree as well?

Yep, definitely copy all of these changes over to edge. And same for 2.16 if they apply.

Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
@wmorgan wmorgan merged commit a2abac2 into main Jan 17, 2025
7 checks passed
@wmorgan wmorgan deleted the wm/gateway-api branch January 17, 2025 19:59
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