Add text to infra docs index

Add descriptive text to the infra documentation index page to help people navigate to the appropriate documentation. This moves the manual into its own section, system-config and publications into a section, and leaves the rest of the projects in a section. Change-Id: I90360ac6822ac93b02fc3bc67b8115dbf750f385
7 years ago · 873789f6bd
2 changed files with 66 additions and 22 deletions
--- a/docs-site/infra-documents.yaml
+++ b/docs-site/infra-documents.yaml
@ -1,6 +1,4 @@
 documents:
-  - name: Infrastructure Manual
-    directory: manual
  - name: Elastic Recheck
    directory: elastic-recheck
  - name: Jenkins Job Builder
@ -11,11 +9,7 @@ documents:
    directory: openstackid
  - name: Shade
    directory: shade
-  - name: Slide Presentations
-    directory: publications
  - name: Storyboard
    directory: storyboard
-  - name: System Configuration
-    directory: system-config
  - name: Zuul
    directory: zuul
--- a/docs-site/infra-index.html.tmpl
+++ b/docs-site/infra-index.html.tmpl
@ -2,9 +2,7 @@
 <html lang="en" xml:lang="en" xmlns="http://www.w3.org/1999/xhtml">
 <head>
  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type"/>
-  <title>
-   OpenStack Specifications
-  </title>
+  <title>OpenStack Developer and Community Infrastructure Documentation</title>
  <script src="http://status.openstack.org/common.js" type="text/javascript">
  </script>
  <!-- Google Fonts -->
@ -85,41 +83,93 @@
   </div>
   <!-- Page Content -->
   <div class="container">
-    <div class="span-12">
-     <h3 class="subhead">
+    <h3 class="subhead">
      OpenStack Developer and Community Infrastructure Documentation
-     </h3>
-    </div>
+    </h3>
    <div class="searchArea span-10 last">
    </div>
   </div>
   <div class="container">
-    <div class="span-12">
+    <div>
+      <p>
+      This is the documentation for the Developer and Community
+      Infrastructure of the OpenStack project itself.  It is intended
+      for developers who are contributing to OpenStack, persons who
+      wish to contribute to the operation of the OpenStack project
+      infrastructure, or other projects who wish to collaborate on the
+      tools we are developing and using.
+      </p>
+      <p>
+      If you are not trying to contribute to OpenStack directly, but
+      are instead a user or developer looking for API documentation,
+      see
+      <a href="http://docs.openstack.org/">OpenStack documentation</a>.
+      </p>
    </div>
   </div>
   <div class="container">
-    <div class="span-12">
-     <div>
-     </div>
-    </div>
+
    <div class="span-12" id="subnav">
     <ul class="subsectionNav">
      <li class="link">
-       <a>
-        Projects
-       </a>
+       <a>Infrastructure Manual</a>
+      </li>
+     </ul>
+     <p style="margin-right: 40px">
+       This is the user manual for the Project Developer
+       Infrastructure.  Read this to learn how to contribute patches
+       to OpenStack, how to create a new OpenStack project, or how to
+       make changes to an existing project's configuration within the
+       project infrastructure.
+     </p>
+
+     <dl>
+       <dd><a href="manual/">Infrastructure Manual</a></dd>
+     </dl>
+
+     <ul class="subsectionNav">
+      <li class="link">
+       <a>Systems Documentation</a>
+      </li>
+     </ul>
+     <p style="margin-right: 40px">
+       The project infrastructure team operates a number of systems
+       for use by the OpenStack project.  Look here to find
+       information about each of them, including how they are
+       installed, configured, and operated, as well as links to
+       relevant external resources.
+     </p>
+
+     <dl>
+       <dd><a href="system-config/">Systems Documentation</a></dd>
+       <dd><a href="publications/">Slide Presentations</a></dd>
+     </dl>
+    </div>
+
+    <div class="span-12 last-right" id="subnav-right">
+     <ul class="subsectionNav">
+      <li class="link">
+       <a>Projects</a>
      </li>
     </ul>
+
+     <p style="margin-right: 40px">
+       These are links to reference documentation for projects that
+       have been developed as part of the OpenStack project
+       infrastructure.
+     </p>
+
     <dl>
 {% for document in documents %}
      <dd>
-       <a href="{{document.directory}}">
+       <a href="{{document.directory}}/">
        {{document.name}}
       </a>
      </dd>
 {% endfor %}
     </dl>
    </div>
+
   </div>
  </div>
  <!-- Page Content -->