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 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) (limited to 'docs/templates/build-instructions.rst') 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. -- cgit 1.2.3-korg