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 ========================================
   7 How to update community lab info on wiki
   8 ========================================
   9
  10
  11 Details about Hosted Community OPNFV Test Labs are located in 3 different places:
  12
  13  - Summarized on the OPNFV wiki [[start#opnfv_community_labs|Start Page]]
  14  - Overview with additional details on the [[pharos#opnfv_test_labs|Pharos Test Bed Governance Project Page]]
  15  - With Project specific information on each project page
  16
  17
  18 How to update the Start Page
  19 -----------------------------
  20
  21 * Clone the Pharos Git repository and make the changes::
  22
  23  git clone ssh://<lfid>@gerrit.opnfv.org:29418/pharos
  24
  25  vi docs/pharos.rst
  26  # use the below guide for MAP
  27
  28  git add docs/pharos.rst
  29
  30  git commit --signoff
  31  # use the proper commit message & include JIRA id
  32
  33  git review -v
  34  # go to gerrit web and add reviewers, wait to have it merged
  35  # after code gets merged http://artifacts.opnfv.org/pharos/docs/pharos.html will contain your change
  36
  37  # edit Wiki page https://wiki.opnfv.org/pharos and look for {{scrape>http://artifacts.opnfv.org/pharos/docs/pharos.html}}
  38  # click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click "Save"
  39  # This must be done as Wiki does not auto update content for now
  40
  41 * 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
  42
  43
  44 How to update the map info on the Pharos Project Page
  45 ------------------------------------------------------
  46
  47   * Login and edit the OPNFV wiki [[pharos#opnfv_test_labs|Pharos Project Page]]
  48   * You will see a section of code as shown below. Add your page to the list with a comma separated list as follows:
  49     * longitude
  50     * latitude
  51     * .8 <- for size
  52     * 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]])
  53     * Nice Format Lab Name
  54     * '';''
  55     * Location Summary
  56     * ''\\'' <-- for a new line
  57     * external link: <-- optional
  58
  59 MAP::
  60
  61  <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="">
  62  50.0117,5.1287,-90,.8,marker-green.png,Pont de Barbouillons; Daverdisse \\ external link:
  63  39.90,116.35,60,.8,marker-red.png,China Mobile Labs;Beijing \\ external link:
  64  45.50,-73.66,60,.8,marker-blue.png,Ericsson Labs;Montreal \\
  65  34.26,108.97,60,.8,marker-green.png, Huawei Labs;Xi an \\
  66  45.53,-122.97,60,.8,marker-green.png,Intel Labs;Hillsboro \\
  67  48.75867,-3.45196,60,.8,marker-gold.png,Orange Labs;Lannion \\
  68  48.82,2.27,60,.8,marker-gold.png,Orange Labs;Paris \\
  69  [[http://test.com|test.com]] \\ internal link: [[::start]]\\ **DW Formatting**
  70  </olmap>
  71
  72
  73 **Documentation tracking**
  74
  75 Revision: _sha1_
  76
  77 Build date:  _date_
  78