openstack/openstack-manuals
Code Issues Proposed changes

Use HTTP/302 temporary redirects for versions

Browse Source 
Redirects from unversioned to versioned pages should rely on
temporary redirects because these change from one release cycle to
the next. Permanent redirects result in browsers holding onto the
redirected path indefinitely, at least until they forget them, which
could still be a very long time.

Change-Id: I22715d9c1248da73c2fbecd8f37fdd80688a2685
Signed-off-by: Jeremy Stanley <fungi@yuggoth.org>
This commit is contained in:
Jeremy Stanley
2025-10-01 14:44:39 +00:00
parent 0b06dc8d4d
commit 1bad9c5212
2 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
www/.htaccess
View File

@@ -34,9 +34,9 @@ redirectmatch {{ code }} ^{{ path }}($|/.*$) {{ result }}
Arguments: Arguments:
path -- the partial regex representing the input path (should not end in /) path -- the partial regex representing the input path (should not end in /)
result -- the subdirectory under /RELEASED_SERIES, (should start with /) result -- the subdirectory under /RELEASED_SERIES, (should start with /)
code -- the response code (defaults to 301) code -- the response code (defaults to 302)
#} #}
{% macro path_to_released_series(path, result, code=301) -%} {% macro path_to_released_series(path, result, code=302) -%}
{{ path_to_page(path, '/' + RELEASED_SERIES + result, code) }} {{ path_to_page(path, '/' + RELEASED_SERIES + result, code) }}
{%- endmacro %} {%- endmacro %}
@@ -66,16 +66,16 @@ redirectmatch {{ code }} ^{{ path }}(?![^/])/?(.*)$ {{ result }}
# Redirect old top-level HTML pages to the version under most recent # Redirect old top-level HTML pages to the version under most recent
# full release. # full release.
redirectmatch 301 ^/$ /{{ RELEASED_SERIES }}/ redirectmatch 302 ^/$ /{{ RELEASED_SERIES }}/
redirectmatch 301 ^/index.html$ /{{ RELEASED_SERIES }}/ redirectmatch 302 ^/index.html$ /{{ RELEASED_SERIES }}/
redirectmatch 301 ^/openstack-projects.html$ /{{ RELEASED_SERIES }}/projects.html redirectmatch 302 ^/openstack-projects.html$ /{{ RELEASED_SERIES }}/projects.html
redirectmatch 301 ^/language-bindings.html$ /{{ RELEASED_SERIES }}/language-bindings.html redirectmatch 302 ^/language-bindings.html$ /{{ RELEASED_SERIES }}/language-bindings.html
# Redirect docs.openstack.org index.html subpage pointers to main page # Redirect docs.openstack.org index.html subpage pointers to main page
{{ dir_to_page('/install', '/' + RELEASED_SERIES + '/install/') }} {{ dir_to_page('/install', '/' + RELEASED_SERIES + '/install/', 302) }}
{{ dir_to_page('/basic-install', '/' + RELEASED_SERIES + '/install/') }} {{ dir_to_page('/basic-install', '/' + RELEASED_SERIES + '/install/', 302) }}
{{ dir_to_page('/run', '/') }} {{ dir_to_page('/run', '/') }}
redirect 301 /developer/index.html /{{ RELEASED_SERIES }}/projects.html redirect 302 /developer/index.html /{{ RELEASED_SERIES }}/projects.html
{{ dir_to_page('/cli', '/') }} {{ dir_to_page('/cli', '/') }}
redirect 301 /api/api-specs.html https://docs.openstack.org/api-quick-start/index.html redirect 301 /api/api-specs.html https://docs.openstack.org/api-quick-start/index.html
@@ -140,7 +140,7 @@ redirect 301 /openstack-ansible-lxc_container_create/ocata/ /openstack-ansible-l
{{ path_to_released_series('/trunk/openstack-ops', '/admin/') }} {{ path_to_released_series('/trunk/openstack-ops', '/admin/') }}
# Redirect api list # Redirect api list
{{ deep_links('/api', '/' + RELEASED_SERIES + '/api/') }} {{ deep_links('/api', '/' + RELEASED_SERIES + '/api/', 302) }}
# Redirect missing project page for openstack-charms # Redirect missing project page for openstack-charms
{{ path_to_page('/openstack-charms', '/charm-guide/') }} {{ path_to_page('/openstack-charms', '/charm-guide/') }}

20
www/redirect-tests.txt
View File

@@ -37,9 +37,9 @@
Arguments: Arguments:
path -- the partial regex representing the input path (should not end in /) path -- the partial regex representing the input path (should not end in /)
result -- the subdirectory under /RELEASED_SERIES, (should start with /) result -- the subdirectory under /RELEASED_SERIES, (should start with /)
code -- the response code (defaults to 301) code -- the response code (defaults to 302)
#} #}
{% macro path_to_released_series(path, result, code=301) -%} {% macro path_to_released_series(path, result, code=302) -%}
{{ path_to_page(path, '/' + RELEASED_SERIES + result, code) }} {{ path_to_page(path, '/' + RELEASED_SERIES + result, code) }}
{%- endmacro %} {%- endmacro %}
@@ -78,16 +78,16 @@
# Redirect old top-level HTML pages to the version under most recent # Redirect old top-level HTML pages to the version under most recent
# full release. # full release.
/ 301 /{{ RELEASED_SERIES }}/ / 302 /{{ RELEASED_SERIES }}/
/index.html 301 /{{ RELEASED_SERIES }}/ /index.html 302 /{{ RELEASED_SERIES }}/
/openstack-projects.html 301 /{{ RELEASED_SERIES }}/projects.html /openstack-projects.html 302 /{{ RELEASED_SERIES }}/projects.html
/language-bindings.html 301 /{{ RELEASED_SERIES }}/language-bindings.html /language-bindings.html 302 /{{ RELEASED_SERIES }}/language-bindings.html
# Redirect docs.openstack.org index.html subpage pointers to main page # Redirect docs.openstack.org index.html subpage pointers to main page
{{ dir_to_page('/install', '/' + RELEASED_SERIES + '/install/') }} {{ dir_to_page('/install', '/' + RELEASED_SERIES + '/install/', 302) }}
{{ dir_to_page('/basic-install', '/' + RELEASED_SERIES + '/install/') }} {{ dir_to_page('/basic-install', '/' + RELEASED_SERIES + '/install/', 302) }}
{{ dir_to_page('/run', '/') }} {{ dir_to_page('/run', '/') }}
/developer/index.html 301 /{{ RELEASED_SERIES }}/projects.html /developer/index.html 302 /{{ RELEASED_SERIES }}/projects.html
{{ dir_to_page('/cli', '/') }} {{ dir_to_page('/cli', '/') }}
/api/api-specs.html 301 https://docs.openstack.org/api-quick-start/index.html /api/api-specs.html 301 https://docs.openstack.org/api-quick-start/index.html
@@ -192,7 +192,7 @@
/doc-contrib-guide/ui-text-guidelines 301 /doc-contrib-guide/ux-ui-guidelines /doc-contrib-guide/ui-text-guidelines 301 /doc-contrib-guide/ux-ui-guidelines
# Redirect any deploy guide project directory back to the current stable index # Redirect any deploy guide project directory back to the current stable index
{{ dir_to_page('/project-deploy-guide', '/' + RELEASED_SERIES + '/deploy/') }} {{ dir_to_page('/project-deploy-guide', '/' + RELEASED_SERIES + '/deploy/', 302) }}
# Redirect all the project deploy folders to their appropriate branch # Redirect all the project deploy folders to their appropriate branch
{# newton is a special case because it exists but is not maintained #} {# newton is a special case because it exists but is not maintained #}
{{ dir_to_page('/project-deploy-guide/newton', '/newton/deploy/') }} {{ dir_to_page('/project-deploy-guide/newton', '/newton/deploy/') }}