Removed index files from all doc directories, rearranged headings, fixed broken links...

[pharos.git] / docs / lab-description / lab_description.rst

diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst
index 5b52baf..da84aa1 100644 (file)
--- a/docs/lab-description/lab_description.rst
+++ b/docs/lab-description/lab_description.rst
@@ -2,10 +2,11 @@
 .. http://creativecommons.org/licenses/by/4.0
 .. (c) 2016 OPNFV.
 
+.. _pharos_lab:
 
-===============================
-Pharos Lab Description Template
-===============================
+**************************
+Lab Specification Template
+**************************
 
 Introduction
 ------------
@@ -14,44 +15,48 @@ Add an summary of what your lab hosts, its focus areas and purpose
 
 
 Lab Resources
-=============
+-------------
 
 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
-| Resource       | Project(s)     | Project Lead   | Email(s)       |  POD Role*     |  Status**      | Notes          |
+| POD Name       | Project(s)     | Project Lead(s)| Email(s)       |  POD Role      |  Status        | Notes          |
 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
-| POD1           |  example       | John Doe       | john@intel.com |  CI: stable    |  Active        |                |
+| POD1           |  project name  | John Doe       | john@abc.com   |  CI: stable    |  Active        |                |
 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
 
-* POD Role: CI stable, CI latest, Dev/test, Stand-alone, ...
-** Status: Assigned, Configuration in progress, Active, Troubleshooting, Can be re-purposed, ...
+* **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description.
+* **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ...
+* **Status:** Assigned, Configuring, Active, Troubleshooting, Available, ...
 
 
-Code of Conduct
-===============
+Acceptable Usage Policy
+-----------------------
 
-Define your lab's  policies and expectations here
+Define lab user policies and expectations
 
 
 Remote Access Infrastructure
-============================
+----------------------------
 
-Describe your lab remote access setup (type of access (VPN?), link speed, any restrictions, etc.)
+Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.)
 
 
-Remote Access Process
-=====================
+Remote Access Procedure
+-----------------------
 
-Define your lab's process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.)
+Define lab process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.)
 
 
-Documentation
-=============
+Lab Documentation
+-----------------
 
-List your lab specific documents here
+List lab specific documents here
 
 
 Lab Topology
-============
+------------
+
+Provide a diagram showing the network topology of lab including lights-out network. Any security sensitive details should
+not be exposed publically. The following diagram is an example only.
 
-.. image:: images/<lab-name>_<diagram-name>.png|.jpg
-   :alt: Name of the diagram
+.. image:: ./images/lab_topology_example.jpg
+   :alt: Lab diagram not found