-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
docs: Remove api v2 #16077
docs: Remove api v2 #16077
Conversation
@htuch as your comment in docs/build.sh suggests the biggest challenge to removing the v2 build is with the version history - i think that will require its own solution there are a few more failures:
if we can agree a way forward for the version history (perhaps linking to old docs ?) then im happy to go through and update not sure about the xds protocol doc - but i guess its a case of updating/rewriting it to point only to v3 xds the other errors are pretty small in number, and im guessing we again just need to update the relevant docs |
Yeah, for version history, let's replace these with HTTP references to the 1.17.0 v2 API docs. It should be possible to sed this, since the references follow a regular pattern, e.g. The rest of the docs should just point to the v3 counterparts. |
@phlax output looks good, happy to review when in ready state. |
0a31534
to
76400cc
Compare
37c8ebf
to
679c18f
Compare
827e328
to
483fbd3
Compare
264bfb3
to
a3c4a76
Compare
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io>
.azure-pipelines/pipelines.yml
Outdated
@@ -102,6 +102,7 @@ stages: | |||
BAZEL_REMOTE_INSTANCE: projects/envoy-ci/instances/default_instance | |||
GCP_SERVICE_ACCOUNT_KEY: $(GcpServiceAccountKey) | |||
displayName: "Generate docs" | |||
continueOnError: true |
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.
remove
@htuch this doesnt remove all of the v2 references - but it gets most of them and prevents the v2 proto -> rst build - so its a pretty good start i think |
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.
LGTM, thanks!
hmmm, I noticed over on #15926 if I fix_proto and fix_format it adds these back: --- a/api/BUILD
I'll just stash those changes and see if CI is happy, but I think we need to fix some auto-gen thing to avoid these being added back |
@alyssawilk i think the fix is #16330 |
Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in #16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io>
Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>
Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in envoyproxy#16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>
Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>
Commit Message: api: Fix generated_api_shadow BUILD Additional Description: Some changes were made to the api/BUILD file in envoyproxy#16077 which were not propagated to generated_api_shadow this is also a possible reason that a dev reported an issue with ci formatting Signed-off-by: Ryan Northey <ryan@synca.io> Signed-off-by: Gokul Nair <gnair@twitter.com>
Signed-off-by: Ryan Northey ryan@synca.io
Commit Message: docs: Remove api v2
Additional Description:
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Deprecated:]
[Optional API Considerations:]