From fe5dba946cbda50aef02eec740c7b14c4685aa61 Mon Sep 17 00:00:00 2001 From: Brian Moss Date: Fri, 20 Nov 2015 14:59:53 +1000 Subject: [PATCH] Add summaries for guides on docs.openstack.org 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 --- www/index.html | 2 ++ www/juno/index.html | 2 ++ www/kilo/index.html | 2 ++ www/liberty/index.html | 2 ++ www/static/common/css/combined.css | 6 ++++++ www/templates/api_guides.tmpl | 2 ++ www/templates/contributor_guides.tmpl | 18 ++++++++++++++---- www/templates/ops_and_admin_guides.tmpl | 7 +++++++ www/templates/training_guides.tmpl | 1 + www/templates/user_guides.tmpl | 5 +++++ 10 files changed, 43 insertions(+), 4 deletions(-) diff --git a/www/index.html b/www/index.html index df2c1f704c..f1d984a522 100644 --- a/www/index.html +++ b/www/index.html @@ -63,6 +63,7 @@

Install Guides

+

Getting started with the most commonly used OpenStack services

Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12 Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7 Installation Guide for Ubuntu 14.04 (LTS) @@ -72,6 +73,7 @@

Configuration Guides

Configuration Reference +

Installation and configuration options for OpenStack

{% include 'templates/ops_and_admin_guides.tmpl' %}
diff --git a/www/juno/index.html b/www/juno/index.html index b5aa9cb365..81ca6247b2 100644 --- a/www/juno/index.html +++ b/www/juno/index.html @@ -64,6 +64,7 @@

Install Guides

+

Getting started with the most commonly used OpenStack services

Installation Guide for openSUSE 13.1 and SUSE Linux Enterprise Server 11 Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 20 Installation Guide for Ubuntu 14.04 (LTS) @@ -72,6 +73,7 @@

Configuration Guides

Configuration Reference +

Installation and configuration options for OpenStack

{% include 'templates/ops_and_admin_guides.tmpl' %}
diff --git a/www/kilo/index.html b/www/kilo/index.html index 70c81c2996..9dba063ce1 100644 --- a/www/kilo/index.html +++ b/www/kilo/index.html @@ -63,6 +63,7 @@

Install Guides

+

Getting started with the most commonly used OpenStack services

Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12 Installation Guide for Red Hat Enterprise Linux 7, CentOS 7, and Fedora 21 Installation Guide for Ubuntu 14.04 (LTS) @@ -71,6 +72,7 @@

Configuration Guides

Configuration Reference +

Installation and configuration options for OpenStack

{% include 'templates/ops_and_admin_guides.tmpl' %}
diff --git a/www/liberty/index.html b/www/liberty/index.html index 386539326f..ff51dfe475 100644 --- a/www/liberty/index.html +++ b/www/liberty/index.html @@ -63,6 +63,7 @@

Install Guides

+

Getting started with the most commonly used OpenStack services

Installation Guide for openSUSE 13.2 and SUSE Linux Enterprise Server 12 Installation Guide for Red Hat Enterprise Linux 7 and CentOS 7 Installation Guide for Ubuntu 14.04 (LTS) @@ -72,6 +73,7 @@

Configuration Guides

Configuration Reference +

Installation and configuration options for OpenStack

{% include 'templates/ops_and_admin_guides.tmpl' %}
diff --git a/www/static/common/css/combined.css b/www/static/common/css/combined.css index 3cfc3bbde7..dd08eaf296 100644 --- a/www/static/common/css/combined.css +++ b/www/static/common/css/combined.css @@ -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; } diff --git a/www/templates/api_guides.tmpl b/www/templates/api_guides.tmpl index 895784871c..90a50fee5f 100644 --- a/www/templates/api_guides.tmpl +++ b/www/templates/api_guides.tmpl @@ -1,5 +1,7 @@

API Guides

API Complete References +

Comprehensive OpenStack API reference

API Guide +

Introduction to using the OpenStack API

diff --git a/www/templates/contributor_guides.tmpl b/www/templates/contributor_guides.tmpl index 2f0e5abaeb..2cb2339de9 100644 --- a/www/templates/contributor_guides.tmpl +++ b/www/templates/contributor_guides.tmpl @@ -1,17 +1,27 @@

Contributor Guides

OpenStack Documentation Contributor Guide +

Documentation workflow and conventions

Python Developer Documentation +

Documentation for OpenStack developers

Language Bindings and Python Clients +

Documentation for the OpenStack Python bindings

OpenStack Project specifications +

Specifications for future project features

OpenStack Project Team Guide - OpenStack Developer and - Community Infrastructure Documentation +

Guide to the OpenStack project and community

+ OpenStack Developer and Community Infrastructure Documentation +

Development and infrastructure documentation

OpenStack Infrastructure User Manual +

Guide to OpenStack software development infrastructure

OpenStack I18n Guide +

Internationalization workflow and conventions

Tempest Test Suite for OpenStack - OpenStack Technical Committee Governance - Documents +

Documentation for the Tempest test project

+ OpenStack Technical Committee Governance Documents +

OpenStack Technical Committee reference documents and official resolutions

Join the OpenStack Foundation +

How to join the OpenStack Foundation

Take the Deployment Survey +

Influence the future of OpenStack

diff --git a/www/templates/ops_and_admin_guides.tmpl b/www/templates/ops_and_admin_guides.tmpl index a8af7d845d..7398a93dc6 100644 --- a/www/templates/ops_and_admin_guides.tmpl +++ b/www/templates/ops_and_admin_guides.tmpl @@ -1,10 +1,17 @@

Operations and Administration Guides

Cloud Administrator Guide +

Manage and troubleshoot an OpenStack cloud

High Availability Guide +

Install and configure OpenStack for high availability

Networking Guide +

Deploy and manage OpenStack Networking (neutron)

Operations Guide +

Design, create, and administer a production OpenStack cloud

Security Guide +

Guidelines and scenarios for creating more secure OpenStack clouds

Virtual Machine Image Guide +

Obtain, create, and modify OpenStack-compatible virtual machine images

Architecture Design Guide +

Guidelines for designing an OpenStack cloud

diff --git a/www/templates/training_guides.tmpl b/www/templates/training_guides.tmpl index 8bc0c50cd2..ced5993e86 100644 --- a/www/templates/training_guides.tmpl +++ b/www/templates/training_guides.tmpl @@ -1,4 +1,5 @@

Training Guides

Upstream training +

Resources for the OpenStack Upstream Training program

diff --git a/www/templates/user_guides.tmpl b/www/templates/user_guides.tmpl index 81de81af64..ed869c7911 100644 --- a/www/templates/user_guides.tmpl +++ b/www/templates/user_guides.tmpl @@ -1,8 +1,13 @@

User Guides

API Guide +

Introduction to using the OpenStack API

End User Guide (includes Python SDK) +

Create and manage resources using the OpenStack dashboard, command-line client, and Python SDK

Admin User Guide +

Manage projects, images, and users in an OpenStack environment

Command-Line Interface Reference +

Comprehensive OpenStack command-line reference

Open source software for application development +

Resources for application development on OpenStack clouds