From 86b1b7ff117ab82a6857a7ef077c4e6579b2e33d Mon Sep 17 00:00:00 2001 From: Kristi Nikolla Date: Sat, 22 Apr 2023 16:22:03 +0200 Subject: [PATCH] Attempt at fixing broken docs This patch attempts to fix the broken docs by having the series name match the branch name (2023.1 instead of 2023.1.antelope) A patch was previously merged and reverted[0]. It changed the name of the series, but missed updating the directory names under the www directory. I did test this locally, and it did correctly pupulate the pages with links for the various projects, but I do not know if it fully resolves the issue. Additionally adds redirects for /2023.1.antelope to /2023.1 and 2023.2.bobcat to 2023.2. [0]. https://review.opendev.org/c/openstack/openstack-manuals/+/880060 Change-Id: I39e0740e57502fd96299fea79409e55e49c10367 --- tools/www-generator.py | 4 ++-- www/.htaccess | 5 +++++ www/{2023.1.antelope => 2023.1}/admin/index.html | 0 www/{2023.1.antelope => 2023.1}/api/index.html | 0 www/{2023.1.antelope => 2023.1}/badge.html | 0 www/{2023.1.antelope => 2023.1}/configuration/index.html | 0 www/{2023.1.antelope => 2023.1}/deploy/index.html | 0 www/{2023.1.antelope => 2023.1}/index.html | 0 www/{2023.1.antelope => 2023.1}/install/index.html | 0 www/{2023.1.antelope => 2023.1}/language-bindings.html | 0 www/{2023.1.antelope => 2023.1}/projects.html | 0 www/{2023.1.antelope => 2023.1}/user/index.html | 0 www/{2023.2.bobcat => 2023.2}/admin/index.html | 0 www/{2023.2.bobcat => 2023.2}/api/index.html | 0 www/{2023.2.bobcat => 2023.2}/badge.html | 0 www/{2023.2.bobcat => 2023.2}/configuration/index.html | 0 www/{2023.2.bobcat => 2023.2}/deploy/index.html | 0 www/{2023.2.bobcat => 2023.2}/index.html | 0 www/{2023.2.bobcat => 2023.2}/install/index.html | 0 www/{2023.2.bobcat => 2023.2}/language-bindings.html | 0 www/{2023.2.bobcat => 2023.2}/projects.html | 0 www/{2023.2.bobcat => 2023.2}/user/index.html | 0 www/redirect-tests.txt | 5 +++++ 23 files changed, 12 insertions(+), 2 deletions(-) rename www/{2023.1.antelope => 2023.1}/admin/index.html (100%) rename www/{2023.1.antelope => 2023.1}/api/index.html (100%) rename www/{2023.1.antelope => 2023.1}/badge.html (100%) rename www/{2023.1.antelope => 2023.1}/configuration/index.html (100%) rename www/{2023.1.antelope => 2023.1}/deploy/index.html (100%) rename www/{2023.1.antelope => 2023.1}/index.html (100%) rename www/{2023.1.antelope => 2023.1}/install/index.html (100%) rename www/{2023.1.antelope => 2023.1}/language-bindings.html (100%) rename www/{2023.1.antelope => 2023.1}/projects.html (100%) rename www/{2023.1.antelope => 2023.1}/user/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/admin/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/api/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/badge.html (100%) rename www/{2023.2.bobcat => 2023.2}/configuration/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/deploy/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/install/index.html (100%) rename www/{2023.2.bobcat => 2023.2}/language-bindings.html (100%) rename www/{2023.2.bobcat => 2023.2}/projects.html (100%) rename www/{2023.2.bobcat => 2023.2}/user/index.html (100%) diff --git a/tools/www-generator.py b/tools/www-generator.py index f7630d1fd4..410f3245db 100755 --- a/tools/www-generator.py +++ b/tools/www-generator.py @@ -74,8 +74,8 @@ SERIES_INFO = collections.OrderedDict([ ('xena', SeriesInfo(date='October 2021', status='maintained')), ('yoga', SeriesInfo(date='April 2022', status='maintained')), ('zed', SeriesInfo(date='October 2022', status='maintained')), - ('2023.1.antelope', SeriesInfo(date='March 2023', status='maintained')), - ('2023.2.bobcat', SeriesInfo(date='October 2023', status='development')), + ('2023.1', SeriesInfo(date='March 2023', status='maintained')), + ('2023.2', SeriesInfo(date='October 2023', status='development')), ]) # Build a list of the series that are not the current series being diff --git a/www/.htaccess b/www/.htaccess index 523f808b85..83c0009684 100644 --- a/www/.htaccess +++ b/www/.htaccess @@ -304,3 +304,8 @@ redirectmatch 301 /infra/nodepool/feature/zuulv3(.*)$ https://zuul-ci.org/docs/n # https://docs.opendev.org/openinfra/refstack {{ deep_links('/refstack', 'https://docs.opendev.org/openinfra/refstack/$1') }} # End redirect refstack + +# Redirect 2023.1.antelope, 2023.2.bobcat to 2023.1, 2023.2 respectively +{{ deep_links('/2023.1.antelope', '/2023.1/$1') }} +{{ deep_links('/2023.2.bobcat', '/2023.2/$1') }} +# End Redirect 2023.1.antelope, 2023.2.bobcat diff --git a/www/2023.1.antelope/admin/index.html b/www/2023.1/admin/index.html similarity index 100% rename from www/2023.1.antelope/admin/index.html rename to www/2023.1/admin/index.html diff --git a/www/2023.1.antelope/api/index.html b/www/2023.1/api/index.html similarity index 100% rename from www/2023.1.antelope/api/index.html rename to www/2023.1/api/index.html diff --git a/www/2023.1.antelope/badge.html b/www/2023.1/badge.html similarity index 100% rename from www/2023.1.antelope/badge.html rename to www/2023.1/badge.html diff --git a/www/2023.1.antelope/configuration/index.html b/www/2023.1/configuration/index.html similarity index 100% rename from www/2023.1.antelope/configuration/index.html rename to www/2023.1/configuration/index.html diff --git a/www/2023.1.antelope/deploy/index.html b/www/2023.1/deploy/index.html similarity index 100% rename from www/2023.1.antelope/deploy/index.html rename to www/2023.1/deploy/index.html diff --git a/www/2023.1.antelope/index.html b/www/2023.1/index.html similarity index 100% rename from www/2023.1.antelope/index.html rename to www/2023.1/index.html diff --git a/www/2023.1.antelope/install/index.html b/www/2023.1/install/index.html similarity index 100% rename from www/2023.1.antelope/install/index.html rename to www/2023.1/install/index.html diff --git a/www/2023.1.antelope/language-bindings.html b/www/2023.1/language-bindings.html similarity index 100% rename from www/2023.1.antelope/language-bindings.html rename to www/2023.1/language-bindings.html diff --git a/www/2023.1.antelope/projects.html b/www/2023.1/projects.html similarity index 100% rename from www/2023.1.antelope/projects.html rename to www/2023.1/projects.html diff --git a/www/2023.1.antelope/user/index.html b/www/2023.1/user/index.html similarity index 100% rename from www/2023.1.antelope/user/index.html rename to www/2023.1/user/index.html diff --git a/www/2023.2.bobcat/admin/index.html b/www/2023.2/admin/index.html similarity index 100% rename from www/2023.2.bobcat/admin/index.html rename to www/2023.2/admin/index.html diff --git a/www/2023.2.bobcat/api/index.html b/www/2023.2/api/index.html similarity index 100% rename from www/2023.2.bobcat/api/index.html rename to www/2023.2/api/index.html diff --git a/www/2023.2.bobcat/badge.html b/www/2023.2/badge.html similarity index 100% rename from www/2023.2.bobcat/badge.html rename to www/2023.2/badge.html diff --git a/www/2023.2.bobcat/configuration/index.html b/www/2023.2/configuration/index.html similarity index 100% rename from www/2023.2.bobcat/configuration/index.html rename to www/2023.2/configuration/index.html diff --git a/www/2023.2.bobcat/deploy/index.html b/www/2023.2/deploy/index.html similarity index 100% rename from www/2023.2.bobcat/deploy/index.html rename to www/2023.2/deploy/index.html diff --git a/www/2023.2.bobcat/index.html b/www/2023.2/index.html similarity index 100% rename from www/2023.2.bobcat/index.html rename to www/2023.2/index.html diff --git a/www/2023.2.bobcat/install/index.html b/www/2023.2/install/index.html similarity index 100% rename from www/2023.2.bobcat/install/index.html rename to www/2023.2/install/index.html diff --git a/www/2023.2.bobcat/language-bindings.html b/www/2023.2/language-bindings.html similarity index 100% rename from www/2023.2.bobcat/language-bindings.html rename to www/2023.2/language-bindings.html diff --git a/www/2023.2.bobcat/projects.html b/www/2023.2/projects.html similarity index 100% rename from www/2023.2.bobcat/projects.html rename to www/2023.2/projects.html diff --git a/www/2023.2.bobcat/user/index.html b/www/2023.2/user/index.html similarity index 100% rename from www/2023.2.bobcat/user/index.html rename to www/2023.2/user/index.html diff --git a/www/redirect-tests.txt b/www/redirect-tests.txt index 3e9cdc40d8..fd8713014e 100644 --- a/www/redirect-tests.txt +++ b/www/redirect-tests.txt @@ -332,3 +332,8 @@ # https://docs.opendev.org/openinfra/refstack {{ deep_links('/refstack', 'https://docs.opendev.org/openinfra/refstack') }} # End redirect refstack + +# Redirect 2023.1.antelope, 2023.2.bobcat to 2023.1, 2023.2 respectively +{{ deep_links('/2023.1.antelope', '/2023.1') }} +{{ deep_links('/2023.2.bobcat', '/2023.2') }} +# End Redirect 2023.1.antelope, 2023.2.bobcat