From a7b9a43192c9d4c1245839e28eb5fc0748122aa3 Mon Sep 17 00:00:00 2001 From: Uli Kleber Date: Fri, 18 Dec 2015 11:35:35 +0100 Subject: Fix Line Length etc for existing docs Jira: DOCS-68 Fixing errors reported by the new tooling. platformoverview/index.rst will be fixed with the new platformoverview document (see separate patch) corrected importing logo images Change-Id: I08f73dcfeef4f2ff3a38a0372491a46798b4026b Signed-off-by: Uli Kleber --- docs/templates/build-instructions.rst | 21 +++++++++++----- docs/templates/index.rst | 2 +- docs/templates/installation-instructions.rst | 37 +++++++++++++++++++--------- docs/templates/release-notes.rst | 10 +++++--- 4 files changed, 49 insertions(+), 21 deletions(-) (limited to 'docs/templates') diff --git a/docs/templates/build-instructions.rst b/docs/templates/build-instructions.rst index 029eddead..3c7a9b8f1 100644 --- a/docs/templates/build-instructions.rst +++ b/docs/templates/build-instructions.rst @@ -14,7 +14,9 @@ License ======= (c) by - is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see . + is licensed under a Creative Commons Attribution 4.0 International License. +You should have received a copy of the license along with this. +If not, see . **Contents** @@ -54,9 +56,12 @@ License : -This document describes build system used to build Fuel@OPNFV, required dependencies and minimum requirements on the host to be used for the buildsystem. +This document describes build system used to build Fuel@OPNFV, +required dependencies and minimum requirements on the host to be used for the buildsystem. -The Fuel build system is desigened around Docker containers such that dependencies outside of the build system can be kept to a minimum. It also shields the host from any potential dangerous operations performed by the build system. +The Fuel build system is desigened around Docker containers such that dependencies +outside of the build system can be kept to a minimum. +It also shields the host from any potential dangerous operations performed by the build system. The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. @@ -81,7 +86,8 @@ The build host should run Ubuntu 14.04 operating system. On the host, the following packages must be installed: -- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. Note: only use the Ubuntu stock distro of Docker (docker.io) +- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. + Note: only use the Ubuntu stock distro of Docker (docker.io) - git (simply available through sudo apt-get install git) @@ -110,7 +116,9 @@ Then restart docker: 3.3.2 Setting up OPNFV Gerrit in order to being able to clone the code ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- Start setting up OPNFV gerrit by creating a SSH key (unless you don't already have one), create one with ssh-keygen + +- Start setting up OPNFV gerrit by creating a SSH key (unless you don't already have one), + create one with ssh-keygen - Add your generated public key in OPNFV Gerrit (this requires a linuxfoundation account, create one if you do not already have one) @@ -189,7 +197,8 @@ For more info type . The artifacts produced are: -- - Which represents the bootable Fuel@OPNFV image, XXXX is replaced with the build identity provided to the build system +- - Which represents the bootable Fuel@OPNFV image, + XXXX is replaced with the build identity provided to the build system - - Which holds version metadata. diff --git a/docs/templates/index.rst b/docs/templates/index.rst index 603615ccb..5fde4e39e 100644 --- a/docs/templates/index.rst +++ b/docs/templates/index.rst @@ -3,7 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -.. image:: ../etc/opnfv-logo.png +.. image:: opnfv-logo.png :height: 40 :width: 200 :alt: OPNFV diff --git a/docs/templates/installation-instructions.rst b/docs/templates/installation-instructions.rst index 58972c1f1..8c46fe9ba 100644 --- a/docs/templates/installation-instructions.rst +++ b/docs/templates/installation-instructions.rst @@ -19,7 +19,9 @@ License ======= (c) by - is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see . + is licensed under a Creative Commons Attribution 4.0 International License. +You should have received a copy of the license along with this. +If not, see . **Contents** @@ -66,10 +68,13 @@ License : -This document describes the supported software and hardware configurations for the Fuel OPNFV reference platform as well as providing guidelines on how to install and +This document describes the supported software and hardware configurations for the +Fuel OPNFV reference platform as well as providing guidelines on how to install and configure such reference system. -Although the available installation options gives a high degree of freedom in how the system is set-up, with what architecture, services and features, etc., not nearly all of those permutations provides a OPNFV compliant reference architecture. Following the guidelines in this document ensures +Although the available installation options gives a high degree of freedom in how the system is set-up, +with what architecture, services and features, etc., not nearly all of those permutations provides +a OPNFV compliant reference architecture. Following the guidelines in this document ensures a result that is OPNFV compliant. The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. @@ -82,7 +87,8 @@ The audience of this document is assumed to have good knowledge in network and U Before starting the installation of Fuel@OPNFV, some planning must preceed. -First of all, the Fuel@OPNFV .iso image needs to be retrieved, the Latest stable Arno release of Fuel@OPNFV can be found here: +First of all, the Fuel@OPNFV .iso image needs to be retrieved, +the Latest stable Arno release of Fuel@OPNFV can be found here: Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: @gerrit.opnf.org/gerrit/genesis> @@ -148,9 +154,15 @@ Following minimum hardware requirements must be met for installation of Fuel@OPN : -The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). The switching connectivity can (but does not need to) be fully redundant, in case it and comprises a redundant 10GE switch pair for “Traffic/Payload/SAN” purposes as well as a 1GE switch pair for “infrastructure control-, management and administration” +The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as +for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). +The switching connectivity can (but does not need to) be fully redundant, +in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as +a 1GE switch pair for "infrastructure control-, management and administration" -The switches are **not** automatically configured from the OPNFV reference platform. All the networks involved in the OPNFV infra-structure as well as the provider networks and the private tenant VLANs needs to be manually configured. +The switches are **not** automatically configured from the OPNFV reference platform. +All the networks involved in the OPNFV infra-structure as well as the provider networks +and the private tenant VLANs needs to be manually configured. This following sections guides through required black-box switch configurations. @@ -166,7 +178,8 @@ This following sections guides through required black-box switch configurations. : -This section describes the installation of the Fuel@OPNFV installation server (Fuel master) as well as the deployment of the full OPNFV reference platform stack across a server cluster. +This section describes the installation of the Fuel@OPNFV installation server (Fuel master) +as well as the deployment of the full OPNFV reference platform stack across a server cluster. Etc. 6.1 Install Fuel master @@ -187,11 +200,12 @@ Etc. : -Now that the OPNFV environment has been created, and before the post installation configurations is started, perform a system health check from the Fuel GUI: +Now that the OPNFV environment has been created, and before the post installation configurations is started, +perform a system health check from the Fuel GUI: -- Select the “Health check” TAB. +- Select the "Health check" TAB. - Select all test-cases -- And click “Run tests” +- And click "Run tests" All test cases except the following should pass: @@ -200,7 +214,8 @@ All test cases except the following should pass: : -After the OPNFV deployment is completed, the following manual changes needs to be performed in order for the system to work according OPNFV standards. +After the OPNFV deployment is completed, the following manual changes needs to be performed in order +for the system to work according OPNFV standards. **Change host OS password:** Change the Host OS password by...... diff --git a/docs/templates/release-notes.rst b/docs/templates/release-notes.rst index 1c08d092f..6941f181f 100644 --- a/docs/templates/release-notes.rst +++ b/docs/templates/release-notes.rst @@ -19,7 +19,9 @@ License ======= (c) by - is licensed under a Creative Commons Attribution 4.0 International License. You should have received a copy of the license along with this. If not, see . + is licensed under a Creative Commons Attribution 4.0 International License. +You should have received a copy of the license along with this. If not, +see . **Contents** @@ -62,7 +64,8 @@ License : -**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master – see the OPNFV@Fuel SW installation instructions +**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master - +see the OPNFV@Fuel SW installation instructions 3 Summary =========== @@ -71,7 +74,8 @@ License : -Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... +Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, +but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... 4 Release Data ================ -- cgit 1.2.3-korg