summaryrefslogtreecommitdiffstats
path: root/docs/configguide/lab_update_guide.rst
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-02-23 23:12:24 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-02-24 15:02:42 -0800
commitc8f8facec439fbc4fced0854845070caf9db38a5 (patch)
tree63e82faa04f6ded59b869838240b803718418445 /docs/configguide/lab_update_guide.rst
parentb2231a970fb73f4f5df72b59ed9d58a039644ac3 (diff)
Removed index files from all doc directories, rearranged headings, fixed broken links and doc formatting issues, created platform overview file, edited content.brahmaputra.1.0
Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/configguide/lab_update_guide.rst')
-rw-r--r--docs/configguide/lab_update_guide.rst85
1 files changed, 42 insertions, 43 deletions
diff --git a/docs/configguide/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst
index ba201ec5..3f90d5cc 100644
--- a/docs/configguide/lab_update_guide.rst
+++ b/docs/configguide/lab_update_guide.rst
@@ -3,49 +3,46 @@
.. (c) 2016 OPNFV.
-========================================
-How to update community lab info on wiki
-========================================
+.. _pharos_wiki:
+*************************
+Updating Pharos Documents
+*************************
-Details about Hosted Community OPNFV Test Labs are located in 3 different places:
+Details about each Community Lab is found in 3 places:
- - Summarized on the OPNFV wiki [[start#opnfv_community_labs|Start Page]]
- - Overview with additional details on the [[pharos#opnfv_test_labs|Pharos Test Bed Governance Project Page]]
- - With Project specific information on each project page
+ - Summary of lab including location, contacts, status, etc. on the `Pharos Project Wiki page <https://wiki.opnfv.org/pharos>`_
+ - Lab specific details are provided with dedicated Wiki pages, see this `Example Lab <https://wiki.opnfv.org/get_started/intel_hosting>`_
+ - 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/images/ ... Lab and POD toplogies
-How to update the Start Page
------------------------------
+Update Pharos repo
+------------------
-* Clone the Pharos Git repository and make the changes::
+Clone the Pharos Git repository
- git clone ssh://<lfid>@gerrit.opnfv.org:29418/pharos
+ * 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
- vi docs/pharos.rst
- # use the below guide for MAP
- git add docs/pharos.rst
+Update Pharos Wiki
+------------------
- git commit --signoff
- # use the proper commit message & include JIRA id
+Edit Wiki page
- git review -v
- # go to gerrit web and add reviewers, wait to have it merged
- # after code gets merged http://artifacts.opnfv.org/pharos/docs/pharos.html will contain your change
+ * 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)
- # edit Wiki page https://wiki.opnfv.org/pharos and look for {{scrape>http://artifacts.opnfv.org/pharos/docs/pharos.html}}
- # click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save"
- # This must be done as Wiki does not auto update content for now
+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:
-How to update the map info on the Pharos Project Page
-------------------------------------------------------
-
- * Login and edit the OPNFV wiki [[pharos#opnfv_test_labs|Pharos Project Page]]
- * You will see a section of code as shown below. Add your page to the list with a comma separated list as follows:
* longitude
* latitude
* .8 <- for size
@@ -56,22 +53,24 @@ How to update the map info on the Pharos Project Page
* ''\\'' <-- for a new line
* external link: <-- optional
+.. MAP Code Example (see Wiki page for current version)::
+
MAP::
- <olmap id="olMapOne" width="800px" height="200px" lat="45.0" lon="0.0" zoom="3" statusbar="1" toolbar="1" controls="1" poihoverstyle="0" baselyr="OpenStreetMap" gpxfile="" kmlfile="">
- 50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\ external link:
- 39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing \\ external link:
- 45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal \\
- 34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an \\
- 45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro \\
- 48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion \\
- 48.82,2.27,60,.8,marker-gold.png,Orange Labs;Paris \\
+ <olmap id="olMapOne" width="877px" height="200px" lat="45.0" lon="0.0" zoom="3" statusbar="1" toolbar="1" controls="1"
+ poihoverstyle="0" baselyr="OpenStreetMap" gpxfile="" kmlfile="">
+ 45.52,-122.67,60,.8,marker-red.png,Linux Foundation;Portland, Oregon \\ external link: [[http://www.test.com|test.com]]
+ 39.7392,-104.9902,60,.8,marker-red.png,Cable Labs;Denver, CA \\ external link: [[http://www.test.com|test.com]]
+ 37.333685,-121.891272,60,.6,marker-green.png,[[pharos/spirentvctlab|Spirent VCT Lab]] \\ San Jose, California
+ 39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing, China \\ external link: [[http://www.test.com|test.com]]
+ 37.413137,-121.977975,-180,.6,marker-red.png,Dell Labs;Santa Clara, California \\ link: [[https://wiki.opnfv.org/dell_hosting]]
+ 59.41,17.95,60,.8,marker-red.png,Enea Pharos Lab;Kista, Sweden \\ external link: [[http://www.enea.com/pharos-lab|ENEA pharos lab]]
+ 45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal, Canada \\ external link: [[http://www.test.com|test.com]]
+ 34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an, China \\ external link: [[http://www.test.com|test.com]]
+ 37.373424,-121.964913,60,.8,marker-green.png, Huawei Labs;Santa Clara, USA \\ external link: [[http://www.test.com|test.com]]
+ 45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro, Oregon \\ link: [[https://wiki.opnfv.org/get_started/intel_hosting|intel_hosting]]
+ 48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion, France \\ external link: [[http://www.test.com|test.com]]
+ 48.825786,2.274797,-60,.8,marker-gold.png,Orange Labs;Paris, France \\ external link: [[http://www.test.com|test.com]]
+ 31.97,118.79,60,.8,marker-red.png,ZTE Labs;Nan Jing, China \\ link:[[zte-nj-testlab|ZTE, Nan Jing]]
[[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting**
</olmap>
-
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date: _date_