openstack/openstack-manuals
Code Issues Proposed changes

Add summaries for guides on docs.openstack.org

Browse Source 
Adds a summary line for each guide on docs.openstack.org
in order to help users find the appropriate book for
their needs.

Adds ".docs-link-sections p" to combined.css to style
the summary lines.

Changes applied to Juno, Kilo, Liberty, and Mitaka.

Change-Id: Ibcbc3d18981a58184646f55b93e77032e4f6c1c0
This commit is contained in:
Brian Moss 2015-11-20 14:59:53 +10:00
parent 74de60c525
commit fe5dba946c
10 changed files with 43 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
www/index.html
View File

@ -63,6 +63,7 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3 id="install-guides"><i class="fa fa-cogs"></i> Install Guides</h3>
<p>Getting started with the most commonly used OpenStack services</p>
<a href="/liberty/install-guide-obs/">Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12</a>
<a href="/liberty/install-guide-rdo/">Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7</a>
<a href="/liberty/install-guide-ubuntu/">Installation Guide for Ubuntu 14.04 (LTS)</a>
@ -72,6 +73,7 @@
<div class="docs-link-sections">
<h3 id="configuration-guides"><i class="fa fa-wrench"></i> Configuration Guides</h3>
<a href="/liberty/config-reference/content/">Configuration Reference</a>
<p>Installation and configuration options for OpenStack</p>
</div>
{% include 'templates/ops_and_admin_guides.tmpl' %}
</div>

2
www/juno/index.html
View File

@ -64,6 +64,7 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3><i class="fa fa-cogs"></i> Install Guides</h3>
<p>Getting started with the most commonly used OpenStack services</p>
<a href="/juno/install-guide/install/zypper/content/">Installation Guide for openSUSE 13.1 and SUSE Linux Enterprise Server 11</a>
<a href="/juno/install-guide/install/yum/content/">Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 20</a>
<a href="/juno/install-guide/install/apt/content/">Installation Guide for Ubuntu 14.04 (LTS)</a>
@ -72,6 +73,7 @@
<div class="docs-link-sections">
<h3><i class="fa fa-wrench"></i> Configuration Guides</h3>
<a href="/juno/config-reference/content/">Configuration Reference</a>
<p>Installation and configuration options for OpenStack</p>
</div>
{% include 'templates/ops_and_admin_guides.tmpl' %}
</div>

2
www/kilo/index.html
View File

@ -63,6 +63,7 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3 id="install-guides"><i class="fa fa-cogs"></i> Install Guides</h3>
<p>Getting started with the most commonly used OpenStack services</p>
<a href="/kilo/install-guide/install/zypper/content/">Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12</a>
<a href="/kilo/install-guide/install/yum/content/">Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 21</a>
<a href="/kilo/install-guide/install/apt/content/">Installation Guide for Ubuntu 14.04 (LTS)</a>
@ -71,6 +72,7 @@
<div class="docs-link-sections">
<h3 id="configuration-guides"><i class="fa fa-wrench"></i> Configuration Guides</h3>
<a href="/kilo/config-reference/content/">Configuration Reference</a>
<p>Installation and configuration options for OpenStack</p>
</div>
{% include 'templates/ops_and_admin_guides.tmpl' %}
</div>

2
www/liberty/index.html
View File

@ -63,6 +63,7 @@
<div class="col-lg-6 col-md-6 col-sm-6">
<div class="docs-link-sections">
<h3 id="install-guides"><i class="fa fa-cogs"></i> Install Guides</h3>
<p>Getting started with the most commonly used OpenStack services</p>
<a href="/liberty/install-guide-obs/">Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12</a>
<a href="/liberty/install-guide-rdo/">Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7</a>
<a href="/liberty/install-guide-ubuntu/">Installation Guide for Ubuntu 14.04 (LTS)</a>
@ -72,6 +73,7 @@
<div class="docs-link-sections">
<h3 id="configuration-guides"><i class="fa fa-wrench"></i> Configuration Guides</h3>
<a href="/liberty/config-reference/content/">Configuration Reference</a>
<p>Installation and configuration options for OpenStack</p>
</div>
{% include 'templates/ops_and_admin_guides.tmpl' %}
</div>

6
www/static/common/css/combined.css
View File

@ -3816,6 +3816,12 @@ input.docs-main-search:-ms-input-placeholder {
.docs-link-sections {
margin: 0 0 80px; }
.docs-link-sections p {
color: gray;
font-size:90%;
padding-left:20px
}
.docs-contribute-wrapper {
padding-bottom: 80px;
text-align: center; }

2
www/templates/api_guides.tmpl
View File

@ -1,5 +1,7 @@
<div class="docs-link-sections">
<h3 id="api-guides"><i class="fa fa-book"></i> API Guides</h3>
<a href="http://developer.openstack.org/api-ref.html">API Complete References</a>
<p>Comprehensive OpenStack API reference</p>
<a href="http://developer.openstack.org/api-guide/quick-start/">API Guide</a>
<p>Introduction to using the OpenStack API</p>
</div>

18
www/templates/contributor_guides.tmpl
View File

@ -1,17 +1,27 @@
<div class="docs-link-sections">
<h3 id="contributor-guides"><i class="fa fa-pencil"></i> Contributor Guides</h3>
<a href="http://docs.openstack.org/contributor-guide/index.html">OpenStack Documentation Contributor Guide</a>
<p>Documentation workflow and conventions</p>
<a href="/developer/openstack-projects.html">Python Developer Documentation</a>
<p>Documentation for OpenStack developers</p>
<a href="/developer/language-bindings.html">Language Bindings and Python Clients</a>
<p>Documentation for the OpenStack Python bindings</p>
<a href="http://specs.openstack.org/">OpenStack Project specifications</a>
<p>Specifications for future project features</p>
<a href="/project-team-guide/">OpenStack Project Team Guide</a>
<a href="/infra/">OpenStack Developer and
Community Infrastructure Documentation</a>
<p>Guide to the OpenStack project and community</p>
<a href="/infra/">OpenStack Developer and Community Infrastructure Documentation</a>
<p>Development and infrastructure documentation</p>
<a href="/infra/manual/">OpenStack Infrastructure User Manual</a>
<p>Guide to OpenStack software development infrastructure</p>
<a href="/developer/i18n/">OpenStack I18n Guide</a>
<p>Internationalization workflow and conventions</p>
<a href="/developer/tempest">Tempest Test Suite for OpenStack</a>
<a href="http://governance.openstack.org">OpenStack Technical Committee Governance
Documents</a>
<p>Documentation for the Tempest test project</p>
<a href="http://governance.openstack.org">OpenStack Technical Committee Governance Documents</a>
<p>OpenStack Technical Committee reference documents and official resolutions</p>
<a href="https://www.openstack.org/join/">Join the OpenStack Foundation</a>
<p>How to join the OpenStack Foundation</p>
<a href="https://www.openstack.org/user-survey/">Take the Deployment Survey</a>
<p>Influence the future of OpenStack</p>
</div>

7
www/templates/ops_and_admin_guides.tmpl
View File

@ -1,10 +1,17 @@
<div class="docs-link-sections">
<h3 id="ops-and-admin-guides"><i class="fa fa-users"></i> Operations and Administration Guides</h3>
<a href="/admin-guide-cloud/">Cloud Administrator Guide</a>
<p>Manage and troubleshoot an OpenStack cloud</p>
<a href="/ha-guide/">High Availability Guide</a>
<p>Install and configure OpenStack for high availability</p>
<a href="/networking-guide/">Networking Guide</a>
<p>Deploy and manage OpenStack Networking (neutron)</p>
<a href="/ops/">Operations Guide</a>
<p>Design, create, and administer a production OpenStack cloud</p>
<a href="/security-guide/">Security Guide</a>
<p>Guidelines and scenarios for creating more secure OpenStack clouds</p>
<a href="/image-guide/content/">Virtual Machine Image Guide</a>
<p>Obtain, create, and modify OpenStack-compatible virtual machine images</p>
<a href="/arch-design/content/">Architecture Design Guide</a>
<p>Guidelines for designing an OpenStack cloud</p>
</div>

1
www/templates/training_guides.tmpl
View File

@ -1,4 +1,5 @@
<div class="docs-link-sections">
<h3 id="training-guides"><i class="fa fa-university"></i> Training Guides</h3>
<a href="/upstream-training/">Upstream training</a>
<p>Resources for the OpenStack Upstream Training program</p>
</div>

5
www/templates/user_guides.tmpl
View File

@ -1,8 +1,13 @@
<div class="docs-link-sections">
<h3 id="user-guides"><i class="fa fa-cloud"></i> User Guides</h3>
<a href="http://developer.openstack.org/api-guide/quick-start/">API Guide</a>
<p>Introduction to using the OpenStack API</p>
<a href="/user-guide/">End User Guide (includes Python SDK)</a>
<p>Create and manage resources using the OpenStack dashboard, command-line client, and Python SDK</p>
<a href="/user-guide-admin/">Admin User Guide</a>
<p>Manage projects, images, and users in an OpenStack environment</p>
<a href="/cli-reference/content/">Command-Line Interface Reference</a>
<p>Comprehensive OpenStack command-line reference</p>
<a href="http://developer.openstack.org">Open source software for application development</a>
<p>Resources for application development on OpenStack clouds</p>
</div>