docs: fixes for release notes for 1.20 #18403
Conversation
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
| @@ -138,7 +138,7 @@ New Features | |||
| * rbac: added :ref:`matcher<envoy_v3_api_field_config.rbac.v3.Permission.matcher>` along with extension category ``extension_category_envoy.rbac.matchers`` for custom RBAC permission matchers. Added reference implementation for matchers :ref:`envoy.rbac.matchers.upstream_ip_port <extension_envoy.rbac.matchers.upstream_ip_port>`. | |||
| * route config: added :ref:`dynamic_metadata <envoy_v3_api_field_config.route.v3.RouteMatch.dynamic_metadata>` for routing based on dynamic metadata. | |||
| * router: added retry options predicate extensions configured via | |||
| :ref:` <envoy_v3_api_field_config.route.v3.RetryPolicy.retry_options_predicates>`. These | |||
| :ref:`<envoy_v3_api_field_config.route.v3.RetryPolicy.retry_options_predicates>`. These | |||
There was a problem hiding this comment.
i think you need to remove the <> around the link if there is no link text - im guessing that is what is causing the docs fail
| @@ -1 +1 @@ | |||
| 1.20.0-dev | |||
| 1.20.0 | |||
There was a problem hiding this comment.
i thought these changes happened on the release branch, rather than main - but not sure how its done
There was a problem hiding this comment.
per GOVERNANCE.md it's supposed to be with the release PR
the one sketchy bit is me setting the dates to the "wrong day" but given the list we have I'd be shocked if we cut the release today and I'm being optimistic about aiming for tomorrow :-P
|
docs are rendered here https://storage.googleapis.com/envoy-pr/18403/docs/index.html |
|
in "NEW FEATURES" there is a bad link for |
|
Hey @envoyproxy/envoy-maintainers 1.20.0 release notes here: https://storage.googleapis.com/envoy-pr/8e2d393/docs/version_history/current.html |
|
yeah I wonder if we should format check rst links better - that's two separate bugs in this release and I swear that's half the updates we do nowadays. either way, fix coming soon! |
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
i have a PR that does this, but i havent pushed it because i wasnt entirely happy with any of the rst linters, and didnt decide on a way forward i will tho (and then hide when everyone moans that they have to wait for docs to be built before the rst formatting issues surface 8/) |
|
Hm, we could add checks for the 2 failure modes we've seen to the existing rst checks, so at least we don't need to run full docs build for release notes checks. WDYT? |
|
i think its probs a good idea - ie very shallow rst lint check in formatting checks, and then more thorough check once the rst has been compiled from protos etc i think the bigger issue is that its not just this file, and running any linter against the current docs creates a humongous list of issues |
|
some other thoughts on this are
|
|
LGTM overall, modulo the broken links. |
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
Signed-off-by: Alyssa Wilk <alyssar@chromium.org>
| @@ -72,6 +72,7 @@ deadline of 3 weeks. | |||
| | 1.17.0 | 2020/12/31 | 2021/01/11 | +11 days | 2022/01/11 | | |||
| | 1.18.0 | 2021/03/31 | 2021/04/15 | +15 days | 2022/04/15 | | |||
| | 1.19.0 | 2021/06/30 | 2021/07/13 | +13 days | 2022/07/13 | | |||
| | 1.20.0 | 2021/09/30 | | | | | |||
| | 1.20.0 | 2021/09/30 | 2021/10/05 | +5 days | 2022/10/13 | | |||
| | 1.20.1 | 2021/12/30 | | | | | |||
There was a problem hiding this comment.
Curious to know why this is 1.20.1 and not 1.21.0 ?
There was a problem hiding this comment.
good spot @suniltheta - do you want to PR to amend ?
cleaning up release notes
Risk Level: n/a
Testing: n/a
Docs Changes: yes
Release Notes: no