gateway icon indicating copy to clipboard operation
gateway copied to clipboard

Published 20 hours ago • verified publisher icon envoyproxy

docs: custom aliases

Open zirain opened this issue 1 year ago • 7 comments

use custom alias.html to make to /tasks/quickstart redirect to /<current_version>/tasks/quickstart

zirain avatar Jun 23 '24 02:06 zirain

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 68.80%. Comparing base (51c6eb4) to head (6f888fb).

Additional details and impacted files 
@@            Coverage Diff             @@
##             main    #3654      +/-   ##
==========================================
- Coverage   68.81%   68.80%   -0.01%     
==========================================
  Files         175      175              
  Lines       21525    21525              
==========================================
- Hits        14812    14810       -2     
- Misses       5636     5637       +1     
- Partials     1077     1078       +1

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jun 23 '24 02:06 codecov[bot]

/retest

zirain avatar Jun 23 '24 02:06 zirain

thanks @zirain ! quick q - how this is impact our release process cc @guydc @Xunzhuo

arkodg avatar Jun 26 '24 18:06 arkodg

thanks @zirain ! quick q - how this is impact our release process cc @guydc @Xunzhuo

should be same as before except https://github.com/envoyproxy/gateway/pull/3654#discussion_r1649848623

zirain avatar Jun 26 '24 20:06 zirain

@zirain can you confirm if a URL like https://gateway.envoyproxy.io/tasks/observability/grafana-integration/ will redirect to https://gateway.envoyproxy.io/v1.0.2/tasks/observability/grafana-integration/ ?

this will impact the URL in the browser, so anyone adding these links in other places will have to manually delete the version from the path

arkodg avatar Jun 26 '24 21:06 arkodg

@zirain one issue with the redirect approach is, it negatively impacts SEO, so ideally prefer if something like https://gateway.envoyproxy.io/tasks/observability/grafana-integration/ can return the current docs (v1.0.2 in this case) w/o changing the URL

https://developers.google.com/search/docs/crawling-indexing/301-redirects?hl=en&sjid=413640029458435414-NC&visit_id=638550359061002202-3950558963&rd=1 highlights that for permanent redirects, the target URL is treated as the strong signal

arkodg avatar Jun 26 '24 22:06 arkodg

@zirain can you confirm if a URL like https://gateway.envoyproxy.io/tasks/observability/grafana-integration/ will redirect to https://gateway.envoyproxy.io/v1.0.2/tasks/observability/grafana-integration/ ?

this will impact the URL in the browser, so anyone adding these links in other places will have to manually delete the version from the path

Request URL:
http://localhost:1313/tasks/observability/proxy-observability/
Request Method:
GET
Status Code:
200 OK
Remote Address:
[::1]:1313
Referrer Policy:
strict-origin-when-cross-origin


Resopnse:

<!doctype html>
<html lang=en>
    <head>
        <title>http://localhost:1313/v1.0.2/tasks/observability/proxy-observability/</title>
        <link rel=canonical href=http://localhost:1313/v1.0.2/tasks/observability/proxy-observability/>
        <meta name=robots content="noindex">
        <meta charset=utf-8>
        <meta http-equiv=refresh content="0; url=http://localhost:1313/v1.0.2/tasks/observability/proxy-observability/">
    </head>
</html>

zirain avatar Jun 27 '24 00:06 zirain

close this one, as it won't help.

zirain avatar Jul 11 '24 09:07 zirain