add a new landing page to list all admin guides

Add an admin-guide.html page that lists all admin guides for all
projects that have them.

Replace the link to the central admin guide on the main page with a link
to the new templated page.

Add a flag to the project data schema to indicate when a project has an
admin guide.

Update the project data to set the has_admin_guide flag for projects
that already have them published.

Change-Id: I514fe5034c26a42cfb4225d521691c32c0ba9ef4
Signed-off-by: Doug Hellmann <doug@doughellmann.com>

tools/www-generator.py

@@ -73,6 +73,8 @@ def _check_url(url):
 _URLS = [
     ('has_install_guide',
      'https://docs.openstack.org/{name}/{series}/install/'),
+    ('has_admin_guide',
+     'https://docs.openstack.org/{name}/{series}/admin/'),
     ('has_config_ref',
      'https://docs.openstack.org/{name}/{series}/configuration/'),
     ('has_in_tree_api_docs',

www/admin-guide.html

@@ -0,0 +1,64 @@
+{% set series = 'latest' %}
+{% set projects = PROJECT_DATA[series] %}
+{% set scriptdir = './common/js/' %}
+{% set cssdir = './common/css/' %}
+{% extends "templates/base.tmpl" %}
+{% block pagetitle %}Administrator Guides{% endblock %}
+{% block title %}
+<a href="https://docs.openstack.org/">Documentation</a> &gt; Administrator Guides
+{% endblock %}
+{% block content %}
+<!-- Begin Page Content -->
+<div class="top-docs-wrapper">
+    <div class="container">
+        <div class="row">
+            <div class="col-lg-8 col-md-8 col-sm-8">
+                <h1>OpenStack Administrator Guides</h1>
+                <p>
+                This page contains documentation about administering OpenStack services.
+                </p>
+           </div>
+        </div>
+    </div>
+    <div class="mid-docs-wrapper" id="docs-main-body">
+        <div class="container">
+            <div class="row docs-toc">
+                <div class="col-lg-6 col-md-6 col-sm-6">
+                    <div class="docs-link-sections">
+                        <h3><i class="fa fa-book"></i> Administrator Guides for OpenStack Services</h3>
+    <a href="/admin/guide/">
+    General OpenStack Administrator Guide
+    </a><br />
+{% for project in projects|sort(attribute='name') -%}
+{% if project.type in ['service', 'other'] and project.has_admin_guide %}
+    <a href="/{{project.name}}/latest/admin/">
+    {{project.service}} ({{project.name}})
+    </a><br />
+{% endif %}
+{%- endfor %}
+                    </div>
+                </div>
+                <div class="col-lg-6 col-md-6 col-sm-6">
+                    <div class="docs-link-sections">
+                        <h3><i class="fa fa-book"></i> Administrator Guides for Common OpenStack Libraries</h3>
+{% for project in projects|sort(attribute='name') -%}
+{% if project.type == 'library' and project.has_admin_guide %}
+    <a href="/{{project.name}}/latest/admin/">
+    {{project.service}} ({{project.name}})
+    </a><br />
+{% endif %}
+{%- endfor %}
+                    </div>
+                </div>
+            </div>
+            <div class="row docs-contribute-wrapper">
+                <div class="col-lg-12">
+                    <p>Documentation treated like code, powered by the community - interested?</p>
+                    <a href="/contributor-guide/" class="overview-btn contribute-btn"
+                    >How To Contribute <i class="fa fa-chevron-right"></i></a>
+                </div>
+            </div>
+        </div>
+    </div>
+
+{% endblock content %}

www/project-data/README.txt

@@ -55,5 +55,7 @@ include a link to that documentation on the templated landing pages.
 
   has_in_tree_api_docs -- produces a link to docs.o.o/name/latest/api/
 
+  has_admin_guide -- produces a link to docs.o.o/name/latest/admin/
+
   NOTE: The documentation associated with the flags must exist before
   the flags are set.

www/project-data/latest.yaml

@@ -6,6 +6,7 @@
   service_type: identity
   has_install_guide: true
   has_api_ref: true
+  has_admin_guide: true
 #  has_config_ref: true
   type: service
 - name: python-keystoneclient
@@ -28,6 +29,7 @@
   has_install_guide: true
   has_api_ref: true
   has_config_ref: true
+  has_admin_guide: true
   type: service
 - name: python-glanceclient
   service: Image service Python Bindings
@@ -61,6 +63,7 @@
   service: Networking service
   service_type: network
   has_install_guide: true
+  has_admin_guide: true
 #  has_api_ref: true  # currently published under /networking/ not /network/
 #  has_config_ref: true
   type: service
@@ -85,6 +88,7 @@
   service: Dynamic Routing service Plug-in
   type: networking
   has_install_guide: true
+  has_admin_guide: true
 - name: neutron-fwaas
   service: Firewall-as-a-Service Plug-in
   type: networking
@@ -99,6 +103,7 @@
   service: OVN Networking service Plug-in
   type: networking
   has_install_guide: true
+  has_admin_guide: true
 - name: networking-sfc
   service: Service Function Chaining Networking service Plug-in
   type: networking
@@ -108,6 +113,7 @@
   service: Dashboard
   has_install_guide: true
   has_config_ref: true
+  has_admin_guide: true
   type: service
 - name: django_openstack_auth
   service: pluggable Django authentication backend for authenticating with Keystone
@@ -120,6 +126,7 @@
   service_type: block-storage
   has_install_guide: true
   has_api_ref: true
+  has_admin_guide: true
 #  has_config_ref: true
   type: service
 - name: python-cinderclient
@@ -140,6 +147,7 @@
   service_type: baremetal
   has_install_guide: true
   has_api_ref: true
+  has_admin_guide: true
 #  has_config_ref: true
   type: service
 - name: python-ironicclient
@@ -178,6 +186,7 @@
 - name: designate
   service: DNS service
   service_type: dns
+  has_admin_guide: true
 #  has_install_guide: true
 #  has_config_ref: true
   has_api_ref: true
@@ -222,6 +231,7 @@
 - name: swift
   service: Object Storage service
   service_type: object-store
+  has_admin_guide: true
 #  has_install_guide: true
 #  has_api_ref: true  # currently published under /object-storage/ not /object-store/
 #  has_config_ref: true
@@ -269,6 +279,7 @@
   service: Telemetry Data Collection service
   service_type: meter
   has_install_guide: true
+  has_admin_guide: true
 #  has_config_ref: true
   type: service
 - name: python-ceilometerclient
@@ -305,6 +316,7 @@
   type: service
   has_in_tree_api_docs: true
   has_install_guide: true
+  has_admin_guide: true
 #  has_config_ref: true
 - name: python-watcherclient
   service: Infrastructure Optimization service Python Bindings
@@ -469,18 +481,22 @@
   service: A logging configuration library.
   has_config_ref: true
   has_install_guide: true
+  has_admin_guide: true
 - name: oslo.messaging
   type: library
   service: Inter-process communication.
+  has_admin_guide: true
 - name: oslo.middleware
   type: library
   service: WSGI middleware library for web service development.
   has_config_ref: true
   has_install_guide: true
+  has_admin_guide: true
 - name: oslo.policy
   type: library
   service: Common policy enforcement.
   has_install_guide: true
+  has_admin_guide: true
 - name: oslo.privsep
   type: library
   service: library for privilege separation
@@ -545,6 +561,7 @@
   has_install_guide: true
   has_api_ref: true
   has_config_ref: true
+  has_admin_guide: true
   type: service
 - name: python-octaviaclient
   service: Load-balancer service client
@@ -672,6 +689,7 @@
 - name: openstack-ansible
   type: deployment
   service: Deploying OpenStack with Ansible
+  has_admin_guide: true
 - name: tripleo-docs
   type: deployment
   service: Deploying OpenStack with TripleO

www/project-data/schema.yaml

@@ -37,3 +37,5 @@ items:
       type: boolean
     has_in_tree_api_docs:
       type: boolean
+    has_admin_guide:
+      type: boolean

www/templates/ops_and_admin_guides.tmpl

@@ -1,5 +1,5 @@
                     <h3 id="ops-and-admin-guides"><i class="fa fa-users"></i> Operations and Administration Guides</h3>
-                    <a href="/admin-guide/">Administrator Guide</a>
+                    <a href="/admin-guide.html">Administrator Guides</a>
                     <p>Manage and troubleshoot an OpenStack cloud</p>
                     <a href="/ha-guide/">High Availability Guide</a><a href="/ha-guide/HAGuide.pdf">[PDF]</a>
                     <p>Install and configure OpenStack for high availability</p>