From 6ea7250c931a3feaad037938ea4f049922961144 Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Wed, 19 Jul 2017 08:23:01 -0400 Subject: [PATCH] be more accurate when checking for guide links Use URLs with index.html to explicitly look for content being published, not just an apache directory listing. Closes-Bug: #1705250 Change-Id: Iae116ee81210489d9de2a1833d341c3842ac95e5 Signed-off-by: Doug Hellmann --- tools/www-generator.py | 20 ++++++++++++-------- www/project-data/latest.yaml | 11 ----------- 2 files changed, 12 insertions(+), 19 deletions(-) diff --git a/tools/www-generator.py b/tools/www-generator.py index 67f512a01a..be63f27f88 100755 --- a/tools/www-generator.py +++ b/tools/www-generator.py @@ -77,23 +77,27 @@ def _check_url(url): # NOTE(dhellmann): List of tuple of flag name and URL template. None # for the flag name means always apply the URL, otherwise look for a # True value associated with the flag in the project data. +# +# NOTE(dhellmann): We use URLs with explicit index.html to ensure that +# a real page is published to the location, and we are not retrieving +# a file list generated by the web server. _URLS = [ (None, - 'https://docs.openstack.org/{name}/{series}/'), + 'https://docs.openstack.org/{name}/{series}/index.html'), ('has_install_guide', - 'https://docs.openstack.org/{name}/{series}/install/'), + 'https://docs.openstack.org/{name}/{series}/install/index.html'), ('has_admin_guide', - 'https://docs.openstack.org/{name}/{series}/admin/'), + 'https://docs.openstack.org/{name}/{series}/admin/index.html'), ('has_config_ref', - 'https://docs.openstack.org/{name}/{series}/configuration/'), + 'https://docs.openstack.org/{name}/{series}/configuration/index.html'), ('has_in_tree_api_docs', - 'https://docs.openstack.org/{name}/{series}/api/'), + 'https://docs.openstack.org/{name}/{series}/api/index.html'), ('has_user_guide', - 'https://docs.openstack.org/{name}/{series}/user/'), + 'https://docs.openstack.org/{name}/{series}/user/index.html'), ('has_api_ref', - 'https://developer.openstack.org/api-ref/{service_type}/'), + 'https://developer.openstack.org/api-ref/{service_type}/index.html'), ('has_api_guide', - 'https://developer.openstack.org/api-guide/{service_type}/'), + 'https://developer.openstack.org/api-guide/{service_type}/index.html'), ] _SERVICE_TYPES_URL = 'http://git.openstack.org/cgit/openstack/service-types-authority/plain/service-types.yaml' # noqa diff --git a/www/project-data/latest.yaml b/www/project-data/latest.yaml index 46dc0f0e2c..7780974eb0 100644 --- a/www/project-data/latest.yaml +++ b/www/project-data/latest.yaml @@ -6,8 +6,6 @@ service_type: identity has_install_guide: true has_api_ref: true - has_admin_guide: true - has_config_ref: true type: service - name: python-keystoneclient service: Identity service Python Bindings @@ -54,7 +52,6 @@ - name: os-vif type: library service: Library for plugging and unplugging virtual interfaces. - has_user_guide: true # - name: osc-placement # type: client # service: OpenStackClient plugin for the Nova Placement service. @@ -133,7 +130,6 @@ service_type: block-storage has_install_guide: true has_api_ref: true - has_admin_guide: true type: service - name: python-cinderclient service: Block Storage service Python Bindings @@ -160,7 +156,6 @@ service: Bare Metal service Python Bindings type: client description: ironic client - has_user_guide: true - name: ironic-inspector service: Bare Metal Introspection service @@ -334,8 +329,6 @@ type: service has_install_guide: true has_api_ref: true - has_admin_guide: true - has_user_guide: true # - name: python-muranoclient # service: Application Catalog service Python Bindings # type: client @@ -346,7 +339,6 @@ service_type: resource-cluster type: service has_install_guide: true - has_user_guide: true # - name: python-senlinclient # service: Clustering service Python Bindings # type: client @@ -369,9 +361,7 @@ service: NFV Orchestration service service_type: nfv-orchestration type: service - has_install_guide: true has_api_ref: true - has_user_guide: true # - name: python-tackerclient # service: NFV Orchestration service Python Bindings # type: client @@ -495,7 +485,6 @@ has_config_ref: true has_install_guide: true has_admin_guide: true - has_user_guide: true - name: oslo.policy type: library service: Common policy enforcement.