docs/release/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.
  15    on the `Pharos Project Wiki page <https://wiki.opnfv.org/display/pharos>`_
  16  - Lab specific details are provided with dedicated Wiki pages,
  17    see this `Example Lab <https://wiki.opnfv.org/display/pharos/Intel+Hosting>`_
  18  - Pharos repo docs ...
  19
  20 .. code: bash
  21
  22     ├── development ... for pharos developer
  23     │   ├── design
  24     │   ├── overview
  25     │   └── requirement
  26     ├── index.rst
  27     └── release ... release documents
  28         ├── configguide
  29         │   ├── configguide.rst
  30         │   ├── jumpserverinstall.rst
  31         │   └── lab_update_guide.rst
  32         ├── images
  33         ├── information
  34         │   └── pharos.rst  ... project information file
  35         ├── release-notes
  36         │   ├── lab-description
  37         │   │   ├── inventory.rst
  38         │   │   ├── lab_description.rst
  39         │   │   └── pod_description.rst
  40         │   ├── labs ... lab specific documents
  41         │   ├── platformoverview
  42         │   │   └── labinfrastructure.rst
  43         │   └── specification
  44         │       ├── hardwarespec.rst
  45         │       ├── networkconfig.rst
  46         │       ├── objectives.rst
  47         │       └── remoteaccess.rst
  48         └── userguide
  49             ├── documentation-example.rst
  50
  51 Update Pharos repo
  52 ------------------
  53
  54 Clone the Pharos Git repository
  55
  56  * git clone https://gerrit.opnfv.org/gerrit/pharos
  57  * Make the changes to Pharos project information file (docs/release/information/pharos.rst)
  58  * Submit changes for review
  59  * After code gets merged http://artifacts.opnfv.org/pharos/docs/release/information/pharos.html
  60    will contain your change
  61
  62
  63 Update Pharos Wiki
  64 ------------------
  65
  66 Edit Wiki page
  67
  68  * https://wiki.opnfv.org/pharos
  69  * Look for {{scrape>http://artifacts.opnfv.org/pharos/docs/release/information/pharos.html}}
  70  * Click "Preview" and see if your change is shown; if shown add a short "Edit summary" and click
  71    "Save" (Wiki does not auto update content)
  72
  73 You will see a section of code as shown below. Add your page to the bullet list with wiki link, nice
  74 name, and location summary
  75
  76 Update the map info on the Pharos Project Page https://wiki.opnfv.org/display/pharos/Community+Labs
  77
  78  * You will see a section of code as shown below. Add your lab infomation to the list with a comma
  79    separated list as follows:
  80
  81     * Location
  82     * Contact
  83     * POD/vPOD
  84     * Role
  85