From e6bf33566af2facecad6bd571c2c91c1ec0b357d Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 26 Sep 2017 15:40:47 -0400 Subject: [PATCH] parameterize the deploy guide list Update the page template for the deployment guide list to use the project-data. Add data to pike for the existing deployment guides. Update the latest project-data file for the available deployment guides for queens. Change-Id: Idc5923ee8b930c75594d42d91450b25be7ee4594 Signed-off-by: Doug Hellmann --- tools/www-generator.py | 2 ++ www/.htaccess | 3 +-- www/pike/deploy/index.html | 10 ++++++++-- www/project-data/latest.yaml | 7 +++++++ www/project-data/pike.yaml | 10 ++++++++++ www/project-data/schema.yaml | 2 ++ www/queens/deploy/index.html | 10 ++++++++-- www/redirect-tests.txt | 3 --- 8 files changed, 38 insertions(+), 9 deletions(-) diff --git a/tools/www-generator.py b/tools/www-generator.py index 96453268ba..9a85b7e199 100755 --- a/tools/www-generator.py +++ b/tools/www-generator.py @@ -177,6 +177,8 @@ _URLS = [ 'https://developer.openstack.org/api-ref/{service_type}/index.html'), ('has_api_guide', ['service'], 'https://developer.openstack.org/api-guide/{service_type}/index.html'), + ('has_deployment_guide', ['deployment'], + 'https://docs.openstack.org/project-deploy-guide/{name}/{series}/index.html'), # noqa ] diff --git a/www/.htaccess b/www/.htaccess index a2a667cdb0..01f7433597 100644 --- a/www/.htaccess +++ b/www/.htaccess @@ -39,7 +39,7 @@ redirectmatch 301 "^/releases(.*)$" http://releases.openstack.org$1 redirectmatch 301 ^/developer/kuryr-(kubernetes|libnetwork|tempest-plugin)/(.*)$ /kuryr-$1/latest/$2 # redirect all kolla sub-repositories appropriately -redirectmatch 301 ^/developer/kolla-(ansible|kubernetes)/(.*)$ /kolla-$1/latest/$2 +redirectmatch 301 ^/developer/kolla-kubernetes/(.*)$ /kolla-kubernetes/latest/$1 # Redirect all openstack-ansible repositories appropriately redirectmatch 301 ^/developer/(ansible-hardening|openstack-ansible-[^/]+)/(.*)$ /$1/latest/$2 @@ -90,7 +90,6 @@ redirect 301 /doc-contrib-guide/ui-text-guidelines /doc-contrib-guide/ux-ui-guid # Redirect any deploy guide project directory back to the current stable index redirectmatch 301 "^/project-deploy-guide/$" /{{RELEASED_SERIES}}/deploy/ -redirectmatch 301 "^/project-deploy-guide/openstack-ansible/$" /project-deploy-guide/openstack-ansible/{{RELEASED_SERIES}}/ redirectmatch 301 "^/project-deploy-guide/newton/" /newton/deploy/ redirectmatch 301 "^/project-deploy-guide/ocata/" /ocata/deploy/ diff --git a/www/pike/deploy/index.html b/www/pike/deploy/index.html index 53710bc8c7..a4677c78d3 100644 --- a/www/pike/deploy/index.html +++ b/www/pike/deploy/index.html @@ -1,3 +1,4 @@ +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} {% block title %} @@ -22,8 +23,13 @@

By deployment method

-

OpenStack-Ansible Deployment Guide

-

Kolla Deployment Guide

+{% for project in projects|sort(attribute='name') -%} +{% if project.type == 'deployment' and project.has_admin_guide %} +

+ {{project.service}} Guide +

+{% endif %} +{%- endfor %}
diff --git a/www/project-data/latest.yaml b/www/project-data/latest.yaml index 59e1c97539..bc2af6d4b9 100644 --- a/www/project-data/latest.yaml +++ b/www/project-data/latest.yaml @@ -844,6 +844,8 @@ service: Deploying OpenStack with Ansible has_admin_guide: true has_user_guide: true + # NOTE(dhellmann): There is no guide at /project-deploy-guide/openstack-ansible/latest/index.html + # has_deployment_guide: true - name: tripleo-docs type: deployment service: Deploying OpenStack with TripleO @@ -869,6 +871,11 @@ service: Tooling for converting subunit streams into a SQL DB type: tool +- name: kolla-ansible + service: Kolla Deployment + type: deployment + # has_deployment_guide: true + # Projects that do not appear in the service-types-authority list: # - kuryr # - dragonflow diff --git a/www/project-data/pike.yaml b/www/project-data/pike.yaml index 095357a6ee..2d5a0e77ee 100644 --- a/www/project-data/pike.yaml +++ b/www/project-data/pike.yaml @@ -736,6 +736,16 @@ type: client description: tricircle client +- name: openstack-ansible + service: OpenStack-Ansible Deployment + type: deployment + has_deployment_guide: true + +- name: kolla-ansible + service: Kolla Deployment + type: deployment + has_deployment_guide: true + # - name: os-win # service: Windows / Hyper-V library for OpenStack projects. # type: library diff --git a/www/project-data/schema.yaml b/www/project-data/schema.yaml index b37a7f9f03..5742bf397e 100644 --- a/www/project-data/schema.yaml +++ b/www/project-data/schema.yaml @@ -43,3 +43,5 @@ items: type: boolean has_in_tree_htaccess: type: boolean + has_deployment_guide: + type: boolean diff --git a/www/queens/deploy/index.html b/www/queens/deploy/index.html index 53710bc8c7..a4677c78d3 100644 --- a/www/queens/deploy/index.html +++ b/www/queens/deploy/index.html @@ -1,3 +1,4 @@ +{% set projects = PROJECT_DATA[SERIES] %} {% extends "templates/base.tmpl" %} {% block pagetitle %}{{SERIES_TITLE}} Deployment Guides{% endblock %} {% block title %} @@ -22,8 +23,13 @@

By deployment method

-

OpenStack-Ansible Deployment Guide

-

Kolla Deployment Guide

+{% for project in projects|sort(attribute='name') -%} +{% if project.type == 'deployment' and project.has_admin_guide %} +

+ {{project.service}} Guide +

+{% endif %} +{%- endfor %}
diff --git a/www/redirect-tests.txt b/www/redirect-tests.txt index 038973a5d3..adcd901a00 100644 --- a/www/redirect-tests.txt +++ b/www/redirect-tests.txt @@ -51,8 +51,6 @@ /developer/kuryr-tempest-plugin/any-page.html 301 /kuryr-tempest-plugin/latest/any-page.html # redirect all kolla sub-repositories appropriately -/developer/kolla-ansible/ 301 /kolla-ansible/latest/ -/developer/kolla-ansible/any-page.html 301 /kolla-ansible/latest/any-page.html /developer/kolla-kubernetes/ 301 /kolla-kubernetes/latest/ /developer/kolla-kubernetes/any-page.html 301 /kolla-kubernetes/latest/any-page.html @@ -131,7 +129,6 @@ # Redirect any deploy guide project directory back to the current stable index /project-deploy-guide/ 301 /{{RELEASED_SERIES}}/deploy/ -/project-deploy-guide/openstack-ansible/ 301 /project-deploy-guide/openstack-ansible/{{RELEASED_SERIES}}/ /project-deploy-guide/newton/ 301 /newton/deploy/ /project-deploy-guide/ocata/ 301 /ocata/deploy/