From f53b39f9f081fd9865849c4547eeb9c27fbcaa0b Mon Sep 17 00:00:00 2001 From: Dmitry Ilyin Date: Mon, 21 Jul 2014 19:10:05 +0400 Subject: [PATCH] Add both pdf and html links to the index page Change-Id: I18b39ba5f7dd2f6ae1608e841c35c7579524aded Closes-Bug: 1289665 --- _templates/mirantis/static/mirantis_style.css | 5 ++ index.rst | 68 +++++++++---------- pages/planning-guide/0010-intro.rst | 2 +- pages/planning-guide/4400-nodes-roles.rst | 2 +- pages/user-guide/2000-install-boot.rst | 2 +- virtualbox.rst | 2 +- 6 files changed, 42 insertions(+), 39 deletions(-) diff --git a/_templates/mirantis/static/mirantis_style.css b/_templates/mirantis/static/mirantis_style.css index 2a91a0293..08bd899b2 100644 --- a/_templates/mirantis/static/mirantis_style.css +++ b/_templates/mirantis/static/mirantis_style.css @@ -515,6 +515,11 @@ a.active { border-left: 1px solid #d5dbe1; } +a.external:before { + content: ""; + padding-right: 0.1em; +} + /* MIRANTIS CSS*/ tt.literal diff --git a/index.rst b/index.rst index dda52eae0..e1bb8843a 100644 --- a/index.rst +++ b/index.rst @@ -11,59 +11,57 @@ Welcome to Mirantis OpenStack Documentation This page contains the most recent Mirantis OpenStack documentation. Select a document from the left menu and navigate through the topics. -PDFs ----- -The following Mirantis OpenStack documentation is available in PDF: +:ref:`planning-guide` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Planning Guide `_ +Planning information you should consider before +installing Fuel and deploying Mirantis OpenStack. - Planning information you should consider before - installing Fuel and deploying Mirantis OpenStack. +:ref:`user-guide` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.. * `Installation Guide `_ +This document describes how to deploy Mirantis OpenStack environments +using Fuel. - This document describes how to pre-configure your - OpenStack environment and install the Fuel Master Node. +:ref:`operations-guide` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `User Guide `_ +A collection of useful procedures for using and managing +your Mirantis OpenStack environment. - This document describes how to deploy Mirantis OpenStack environments - using Fuel. +:ref:`virtualbox` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Operations Guide `_ +This document provides information about running Mirantis OpenStack on VirtualBox +for demonstration and evaluation purposes. - A collection of useful procedures for using and managing - your Mirantis OpenStack environment. +:ref:`ref-arch` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Running Mirantis OpenStack on VirtualBox `_ +A deep dive into the structure of the Mirantis OpenStack environment, +network considerations, and deployment options. - This document provides information about running Mirantis OpenStack on VirtualBox - for demonstration and evaluation purposes. +:ref:`terminology-ref` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Reference Architecture `_ +Short articles about OpenStack terminology and technology +with references to other documentation and other useful information. - A deep dive into the structure of the Mirantis OpenStack environment, - network considerations, and deployment options. +:ref:`release-notes` `(pdf) `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Terminology Reference `_ +The Release Notes provide general information about new features, +fixed issues, and known limitations in Mirantis OpenStack |version|. - Short articles about OpenStack terminology and technology - with references to other documentation and other useful information. +`Download Mirantis OpenStack `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -* `Release Notes 5.0 `_ - - The Release Notes provide general information about new features, - fixed issues, and known limitations in Mirantis OpenStack |version|. - -Download Mirantis OpenStack ---------------------------- You can download the Mirantis OpenStack ISO, IMG, and VirtualBox scripts at http://software.mirantis.com .. note:: You must sign in to download Mirantis OpenStack. If you do not have an account, sign up for a free account now. -Demos and tutorials: --------------------- -Watch the Mirantis OpenStack demos: +`Demos and tutorials `__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -https://vimeo.com/96222550 +Watch the Mirantis OpenStack demos at https://vimeo.com/96222550 diff --git a/pages/planning-guide/0010-intro.rst b/pages/planning-guide/0010-intro.rst index 2ef8813d9..8a9ae3063 100644 --- a/pages/planning-guide/0010-intro.rst +++ b/pages/planning-guide/0010-intro.rst @@ -52,7 +52,7 @@ You can also run Fuel to deploy a Mirantis OpenStack Environment on Oracle VirtualBox. VirtualBox deployment is useful for demonstrations and is a good way to begin your exploration of the tools and technologies. -It is discussed in :ref:`Running Fuel on VirtualBox`. +It is discussed in :ref:`Running Fuel on VirtualBox`. However, it is worth noting that deployments on top of VirtualBox do not generally meet the performance and robustness requirements of most production environments. diff --git a/pages/planning-guide/4400-nodes-roles.rst b/pages/planning-guide/4400-nodes-roles.rst index f8a8b4900..e10bbe92d 100644 --- a/pages/planning-guide/4400-nodes-roles.rst +++ b/pages/planning-guide/4400-nodes-roles.rst @@ -38,7 +38,7 @@ Some general guiding principles: and to avoid performance bottlenecks. - For demonstration and study purposes, you can deploy OpenStack on VirtualBox; - see :ref:`Running Fuel on VirtualBox` for more information. + see :ref:`Running Fuel on VirtualBox` for more information. This option has the lowest hardware requirements - OpenStack can be deployed on smaller hardware configurations by combining multiple roles on the nodes diff --git a/pages/user-guide/2000-install-boot.rst b/pages/user-guide/2000-install-boot.rst index 54a18034b..360da8a18 100644 --- a/pages/user-guide/2000-install-boot.rst +++ b/pages/user-guide/2000-install-boot.rst @@ -34,7 +34,7 @@ then use that media to install the software. In that case, copy the ISO file to the approriate directory and boot directly from that disk file. See the `Quick Start Guide `_. - and :ref:`virtualbox-top`. + and :ref:`virtualbox`. Use any standard software to burn the ISO to a writeable DVD. diff --git a/virtualbox.rst b/virtualbox.rst index 74488ac5a..7e2c49cd6 100644 --- a/virtualbox.rst +++ b/virtualbox.rst @@ -1,6 +1,6 @@ .. index:: VirtualBox Installation -.. _virtualbox-top: +.. _virtualbox: ======================================== Running Mirantis OpenStack on VirtualBox