site: add a Gateway API v1alpha2 guide #4122
Conversation
skriss
requested review from
sunjayBhatia and
youngnick
and removed request for
a team
|
Let's hold off on merging this until just before 1.20 is released, since guides aren't currently versioned. |
Codecov Report
@@ Coverage Diff @@
## main #4122 +/- ##
=======================================
Coverage 76.71% 76.71%
=======================================
Files 114 114
Lines 10049 10049
=======================================
Hits 7709 7709
Misses 2149 2149
Partials 191 191 |
skriss
force-pushed
the
gateway-v1alpha2-guide
branch
from
c0ea4a9 to
18d12ac
Compare
site/content/guides/gateway-api.md
Outdated
| @@ -129,7 +105,7 @@ This command creates: | |||
|
|
|||
| - A Deployment named `kuard` in namespace `projectcontour` to run kuard as the test application. | |||
| - A Service named `kuard` in namespace `projectcontour` to expose the kuard application on TCP port 80. | |||
| - An HTTPRoute named `kuard` in namespace `projectcontour` to route requests for "*.projectcontour.io" to the kuard | |||
| - An HTTPRoute named `kuard` in namespace `projectcontour` to route requests for `local.projectcontour.io` to the kuard | |||
There was a problem hiding this comment.
Maybe move the sample HTTPRoute removed above to here so folks can copy/paste follow along?
There was a problem hiding this comment.
The HTTPRoute is defined in https://github.com/projectcontour/contour/blob/18d12ac3a00eea97b88aab2eb4c8ecb36528eb85/examples/gateway/kuard/kuard.yaml (which is why I removed it from above), are you saying remove it from kuard.yaml and put it directly in the guide instead?
There was a problem hiding this comment.
Not sure if it helps to see the route in the guide to understand what's going on. There's a balance between re-explaining how GatewayAPI works vs letting folks read up on those bits on their own.
There was a problem hiding this comment.
We could possibly look at using the include functionality in Hugo to include the file directly?
skriss
force-pushed
the
gateway-v1alpha2-guide
branch
from
18d12ac to
5e722df
Compare
|
Marking this PR stale since there has been no activity for 14 days. It will be closed if there is no activity for another 30 days. |
github-actions
bot
added
the
lifecycle/stale
skriss
removed
the
lifecycle/stale
|
Marking this PR stale since there has been no activity for 14 days. It will be closed if there is no activity for another 30 days. |
github-actions
bot
added
the
lifecycle/stale
Adds a second copy of the Gateway API guide, for v1alpha2. Once Contour 1.20 is released, the v1alpha1 guide will be dropped and the v1alpha2 guide will be updated with the proper links. Updates projectcontour#4091. Signed-off-by: Steve Kriss <krisss@vmware.com>
skriss
force-pushed
the
gateway-v1alpha2-guide
branch
from
5e722df to
6de0a92
Compare
skriss
changed the title
|
Since we're releasing a beta, I updated this PR to add a v1alpha2 guide without dropping the v1alpha1 one. I'll do another PR closer to the 1.20 GA release to drop the old guide. Side note: this is a good example of why it'd be nice to move to versioned guides (#3829) |
skriss
removed
lifecycle/stale
Adds a second copy of the Gateway API
guide, for v1alpha2. Once Contour 1.20
is released, the v1alpha1 guide will
be dropped and the v1alpha2 guide will
be updated with the proper links.
Updates #4091.
Signed-off-by: Steve Kriss krisss@vmware.com