From 988cf64e3a7601396e40b08a1aae07a524bf8c74 Mon Sep 17 00:00:00 2001 From: 10013968 Date: Mon, 18 Jul 2016 23:51:00 +0800 Subject: Reformat the rst documents Main changes: Set the textwidth to 100, exceptions: tables and http links may be longer than the limits Cut off the table width as shorten as possible JIRA: PHAROS-227 Change-Id: I07861e675d76ab5063f388d3be7d0b51c8bad38b Signed-off-by: 10013968 --- docs/configguide/lab_update_guide.rst | 18 ++++++++++-------- docs/configguide/pharosconfig.rst | 15 ++++++++------- 2 files changed, 18 insertions(+), 15 deletions(-) (limited to 'docs/configguide') diff --git a/docs/configguide/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst index 98aec638..c939164c 100644 --- a/docs/configguide/lab_update_guide.rst +++ b/docs/configguide/lab_update_guide.rst @@ -18,7 +18,8 @@ Details about each Community Lab is found in 3 places: - Pharos repo docs ... - docs/information/pharos.rst ... project information file - - docs/labs/ ... Lab documents (includes lab specific capabilities, usages and policies; POD information) + - docs/labs/ ... Lab documents (includes lab specific capabilities, usages and policies; + POD information) - docs/labs/images/ ... Lab and POD toplogies Update Pharos repo @@ -27,7 +28,8 @@ Update Pharos repo Clone the Pharos Git repository * Make the changes to Pharos project information file (docs/information/pharos.rst) - * After code gets merged http://artifacts.opnfv.org/pharos/docs/information/pharos.html will contain your change + * After code gets merged http://artifacts.opnfv.org/pharos/docs/information/pharos.html will + contain your change Update Pharos Wiki @@ -37,16 +39,16 @@ Edit Wiki page * https://wiki.opnfv.org/pharos * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/information/pharos.html}} - * Click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save" - (Wiki does not auto update content) + * Click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click + "Save" (Wiki does not auto update content) -You will see a section of code as shown below. Add your page to the bullet list with wiki link, -nice name, and location summary +You will see a section of code as shown below. Add your page to the bullet list with wiki link, nice +name, and location summary Update the map info on the Pharos Project Page https://wiki.opnfv.org/pharos?&#community_labs - * You will see a section of code as shown below. Add your lab infomation to the list with a comma separated - list as follows: + * You will see a section of code as shown below. Add your lab infomation to the list with a comma + separated list as follows: * longitude * latitude diff --git a/docs/configguide/pharosconfig.rst b/docs/configguide/pharosconfig.rst index 6b0783de..6b48100a 100644 --- a/docs/configguide/pharosconfig.rst +++ b/docs/configguide/pharosconfig.rst @@ -8,14 +8,15 @@ Pharos Configuration ******************** -OPNFV development, test and production activities rely on Pharos resources and support from the Pharos community. Lab -owners and Pharos project committers/contributors will evolve the vision for Pharos as well as expand lab capabilities -that are needed to help OPNFV be highly successful. +OPNFV development, test and production activities rely on Pharos resources and support from the +Pharos community. Lab owners and Pharos project committers/contributors will evolve the vision for +Pharos as well as expand lab capabilities that are needed to help OPNFV be highly successful. -Pharos configuration documents provide information on how to setup hardware and networks in a Pharos compliant lab. Jira -is used to track Pharos activities including lab operations. PODs are connected to Jenkins and generally available 24/7 -other than scheduled maintenance and troubleshooting. Lab resources are declared as either for *Development (bare-metal -or virtual)*, *Production latest (bare-metal)* or *Production stable (bare-metal)* +Pharos configuration documents provide information on how to setup hardware and networks in a Pharos +compliant lab. Jira is used to track Pharos activities including lab operations. PODs are connected +to Jenkins and generally available 24/7 other than scheduled maintenance and troubleshooting. Lab +resources are declared as either for *Development (bare-metal or virtual)*, *Production latest +(bare-metal)* or *Production stable (bare-metal)* .. toctree:: -- cgit 1.2.3-korg