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

Deprecated extension documentation link is broken #11078

Closed
jpeach opened this issue May 6, 2020 · 9 comments · Fixed by #11115
Closed

Deprecated extension documentation link is broken #11078

jpeach opened this issue May 6, 2020 · 9 comments · Fixed by #11115
Assignees
Milestone

Comments

@jpeach
Copy link
Contributor

jpeach commented May 6, 2020

The deprecation warning emitted when a deprecated feature is used contains a documentation link that is 404.

[2020-05-06 00:14:08.017][1][warning][misc] [bazel-out/k8-opt/bin/source/extensions/common/_virtual_includes/utility_lib/extensions/common/utility.h:65] Using deprecated extension name 'envoy.grpc_web' for 'envoy.filters.http.grpc_web'. This name will be removed from Envoy soon. Please see https://www.envoyproxy.io/docs/envoy/latest/intro/deprecated for details.

The link https://www.envoyproxy.io/docs/envoy/latest/intro/deprecated returns 404

$ curl -L -v https://www.envoyproxy.io/docs/envoy/latest/intro/deprecated
*   Trying 157.230.37.202:443...
* Connected to www.envoyproxy.io (157.230.37.202) port 443 (#0)
* ALPN, offering http/1.1
* TLS 1.2 connection using TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* Server certificate: envoyproxy.io
* Server certificate: Let's Encrypt Authority X3
* Server certificate: DST Root CA X3
> GET /docs/envoy/latest/intro/deprecated HTTP/1.1
> Host: www.envoyproxy.io
> User-Agent: curl/7.70.0
> Accept: */*
>
* Mark bundle as not supporting multiuse
< HTTP/1.1 404 Not Found
...
@alyssawilk
Copy link
Contributor

Whoops, I think that's due to the generally awesome docs refactor in #10730

We could point folks to https://www.envoyproxy.io/docs/envoy/latest/version_history/version_history instead, but making them wander through pages doesn't seem as useful. Per Matt's point over in #11058 I wonder if we can leverage the annotations to print out something field-specific and useful, or just point them at API docs which will be specific and useful?

@ggreenway @mattklein123 @htuch

@htuch
Copy link
Member

htuch commented May 6, 2020

In this specific case, this is just the new vs. old names for extensions, so we can provide a fixed anchor.

It should be fairly easy to autogenerate a link back to the field specific docs in general though, from browser copy+paste, this is what the href looks like: https://www.envoyproxy.io/docs/envoy/latest/api-v3/config/core/v3/health_check.proto#envoy-v3-api-field-config-core-v3-healthcheck-transport-socket-match-criteria

@ggreenway
Copy link
Contributor

Ideally, we'd have a released version not point at latest, but at it's version of the docs, so any future movement of pages won't invalidate those links.

Field-specific doc-links would be great, but I don't know if it's worth the effort or not.

@mattklein123
Copy link
Member

Ideally, we'd have a released version not point at latest, but at it's version of the docs, so any future movement of pages won't invalidate those links.

Yeah this would probably be the "simplest." I wonder if it could be done with a short generated header/cc file that is based on the VERSION file?

@mattklein123 mattklein123 added the help wanted Needs help! label May 6, 2020
@mattklein123 mattklein123 added this to the 1.15.0 milestone May 6, 2020
@htuch
Copy link
Member

htuch commented May 6, 2020

We already have this constant that we use for the build version string.

@jpeach
Copy link
Contributor Author

jpeach commented May 7, 2020

Independently of how this link will be managed in the future, shipping envoy versions are emitting this message today. Is it possible to add a redirect to support people who are currently seeing this message?

@jpeach
Copy link
Contributor Author

jpeach commented May 7, 2020

xref #8465

@mattklein123
Copy link
Member

Is it possible to add a redirect to support people who are currently seeing this message?

Doc PRs appreciated.

@ggreenway ggreenway self-assigned this May 8, 2020
@ggreenway
Copy link
Contributor

I'll fix this soon. My mess, mine to cleanup :)

ggreenway added a commit to ggreenway/envoy that referenced this issue May 8, 2020
The links were broken in 8e8209f

Fixes: envoyproxy#11078

Signed-off-by: Greg Greenway <ggreenway@apple.com>
ggreenway added a commit that referenced this issue May 9, 2020
The links were broken in 8e8209f

Fixes: #11078

Signed-off-by: Greg Greenway <ggreenway@apple.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants