diff options
author | Uli Kleber <ulrich.kleber@huawei.com> | 2015-12-18 11:35:35 +0100 |
---|---|---|
committer | Uli Kleber <ulrich.kleber@huawei.com> | 2015-12-18 15:01:17 +0100 |
commit | a7b9a43192c9d4c1245839e28eb5fc0748122aa3 (patch) | |
tree | 13b73b200307fd47cd82b1f4cf9c2a175ac5c32f /docs/templates/build-instructions.rst | |
parent | be1b876c56adee484957f8a8f1c614eacdc828f5 (diff) |
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 <ulrich.kleber@huawei.com>
Diffstat (limited to 'docs/templates/build-instructions.rst')
-rw-r--r-- | docs/templates/build-instructions.rst | 21 |
1 files changed, 15 insertions, 6 deletions
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 ======= <WORK'S NAME> (c) by <AUTHOR'S NAME> -<WORK'S NAME> 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 <http://creativecommons.org/licenses/by/4.0/>. +<WORK'S NAME> 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 <http://creativecommons.org/licenses/by/4.0/>. **Contents** @@ -54,9 +56,12 @@ License <EXAMPLE>: -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 <https://gerrit.opnfv.org/> (this requires a linuxfoundation account, create one if you do not already have one) @@ -189,7 +197,8 @@ For more info type <fuel/ci/build.sh -h>. The artifacts produced are: -- <OPNFV_XXXX.iso> - Which represents the bootable Fuel@OPNFV image, XXXX is replaced with the build identity provided to the build system +- <OPNFV_XXXX.iso> - Which represents the bootable Fuel@OPNFV image, + XXXX is replaced with the build identity provided to the build system - <OPNFV_XXXX.iso.txt> - Which holds version metadata. |