docs/configguide/lab_update_guide.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2016 OPNFV.
   4
   5
   6 .. _pharos_wiki:
   7
   8 *************************
   9 Updating Pharos Documents
  10 *************************
  11
  12 Details about each Community Lab is found in 3 places:
  13
  14  - Summary of lab including location, contacts, status, etc. on the `Pharos Project Wiki page <https://wiki.opnfv.org/pharos>`_
  15  - Lab specific details are provided with dedicated Wiki pages, see this `Example Lab <https://wiki.opnfv.org/get_started/intel_hosting>`_
  16  - Pharos repo docs ...
  17
  18     - docs/information/pharos.rst ... project information file
  19     - docs/labs/ ... Lab documents (includes lab specific capabilities, usages and policies; POD information)
  20     - docs/labs/images/ ... Lab and POD toplogies
  21
  22 Update Pharos repo
  23 ------------------
  24
  25 Clone the Pharos Git repository
  26
  27  * Make the changes to Pharos project information file (docs/information/pharos.rst)
  28  * After code gets merged http://artifacts.opnfv.org/pharos/docs/information/pharos.html will contain your change
  29
  30
  31 Update Pharos Wiki
  32 ------------------
  33
  34 Edit Wiki page
  35
  36  * https://wiki.opnfv.org/pharos
  37  * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/information/pharos.html}}
  38  * 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)
  39
  40 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
  41
  42 Update the map info on the Pharos Project Page https://wiki.opnfv.org/pharos?&#community_labs
  43
  44  * You will see a section of code as shown below. Add your lab infomation to the list with a comma separated list as follows:
  45
  46     * longitude
  47     * latitude
  48     * .8 <- for size
  49     * marker color png ([[marker-green.png|marker-green.png]], [[marker-blue.png|marker-blue.png]], [[marker-red.png|marker-red.png]], [[marker-gold.png|marker-gold.png]])
  50     * Nice Format Lab Name
  51     * '';''
  52     * Location Summary
  53     * ''\\'' <-- for a new line
  54     * external link: <-- optional
  55
  56 .. MAP Code Example (see Wiki page for current version)::
  57
  58 MAP::
  59
  60  <olmap id="olMapOne" width="877px" height="200px" lat="45.0" lon="0.0" zoom="3" statusbar="1" toolbar="1" controls="1"
  61  poihoverstyle="0" baselyr="OpenStreetMap" gpxfile="" kmlfile="">
  62  45.52,-122.67,60,.8,marker-red.png,Linux Foundation;Portland, Oregon \\ external link: [[http://www.test.com|test.com]]
  63  39.7392,-104.9902,60,.8,marker-red.png,Cable Labs;Denver, CA \\ external link: [[http://www.test.com|test.com]]
  64  37.333685,-121.891272,60,.6,marker-green.png,[[pharos/spirentvctlab|Spirent VCT Lab]] \\ San Jose, California
  65  39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing, China \\ external link: [[http://www.test.com|test.com]]
  66  37.413137,-121.977975,-180,.6,marker-red.png,Dell Labs;Santa Clara, California \\ link: [[https://wiki.opnfv.org/dell_hosting]]
  67  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]]
  68  45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal, Canada \\ external link: [[http://www.test.com|test.com]]
  69  34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an, China \\ external link: [[http://www.test.com|test.com]]
  70  37.373424,-121.964913,60,.8,marker-green.png, Huawei Labs;Santa Clara, USA \\ external link: [[http://www.test.com|test.com]]
  71  45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro, Oregon \\ link: [[https://wiki.opnfv.org/get_started/intel_hosting|intel_hosting]]
  72  48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion, France \\ external link: [[http://www.test.com|test.com]]
  73  48.825786,2.274797,-60,.8,marker-gold.png,Orange Labs;Paris, France \\ external link: [[http://www.test.com|test.com]]
  74  31.97,118.79,60,.8,marker-red.png,ZTE Labs;Nan Jing, China \\ link:[[zte-nj-testlab|ZTE, Nan Jing]]
  75  [[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting**
  76  </olmap>