-
Notifications
You must be signed in to change notification settings - Fork 216
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
Conversation
Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
Signed-off-by: William Morgan <[email protected]>
There was a problem hiding this 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]>
Signed-off-by: William Morgan <[email protected]>
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. |
There was a problem hiding this 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]>
There was a problem hiding this 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]>
Signed-off-by: William Morgan <[email protected]>
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]>
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]>
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:
policy.linkerd.io
types, and instead note that they are supported but deprecatedPlease 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