From b38808ab6148dcedba64678c5220d178d43a48c4 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 2 Feb 2016 10:18:49 -0800 Subject: Fixed link to pharos page v2: Minor changes to doc text and formatting Change-Id: I50c29118a2b3eeaa1bceb6393ca0e0794a7743ed Signed-off-by: Trevor Cooper Added license headers to all doc files Moved master index to docs/ --- .gitignore | 68 ++++++++++++++++++++++++++++++++ docs/configguide/configguide.rst | 10 ++++- docs/configguide/lab_update_guide.rst | 8 +++- docs/index.rst | 49 +++++++++++++++++++++++ docs/information/index.rst | 8 +++- docs/information/pharos.rst | 17 ++++++-- docs/lab-description/index.rst | 10 ++++- docs/lab-description/lab_description.rst | 6 +++ docs/lab-description/pod_description.rst | 6 +++ docs/specification/hardwarespec.rst | 5 +++ docs/specification/index.rst | 8 +++- docs/specification/jumpserverinstall.rst | 8 +++- docs/specification/networkconfig.rst | 5 +++ docs/specification/objectives.rst | 5 +++ docs/specification/remoteaccess.rst | 5 +++ 15 files changed, 206 insertions(+), 12 deletions(-) create mode 100644 .gitignore create mode 100755 docs/index.rst diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..1a23762c --- /dev/null +++ b/.gitignore @@ -0,0 +1,68 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*.confc + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +eggs/ +lib64/ +parts/ +sdist/ +var/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Translations +*.mo +*.pot + +# Log files: +*.log + +# Sphinx documentation +docs/_build/ + +# PyBuilder +target/ + +# SublimeText +*.sublime-project +*.sublime-workspace + +*~ +.*.sw? +/docs_build/ +/docs_output/ +/releng/ +/src/dpdk/dpdk/ +/src/ovs/ovs/ +/src/qemu/qemu/ +/src_cuse/ +/src_vanilla/ diff --git a/docs/configguide/configguide.rst b/docs/configguide/configguide.rst index 92d23b72..71fbd091 100644 --- a/docs/configguide/configguide.rst +++ b/docs/configguide/configguide.rst @@ -1,5 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +===================================== Pharos Lab Configuration requirements ===================================== -Add an overview for the Pharos configuration guide here. This should be informative regarding the tasks -and expectations when configuring a lab to be pharos compliant and refer to the relevant pharos docs published from the project. +.. Add an overview for the Pharos configuration guide here. This should be informative regarding the tasks +.. and expectations when configuring a lab to be pharos compliant and refer to the relevant pharos docs published from the project. diff --git a/docs/configguide/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst index 8abab9f3..d6025154 100644 --- a/docs/configguide/lab_update_guide.rst +++ b/docs/configguide/lab_update_guide.rst @@ -1,4 +1,10 @@ -How to update the lab info on this wiki +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +======================================== +How to update community lab info on wiki ======================================== diff --git a/docs/index.rst b/docs/index.rst new file mode 100755 index 00000000..8e24f7e2 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,49 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. OPNFV Pharos Documentation master file. + +.. image:: ../etc/opnfv-logo.png + :height: 40 + :width: 200 + :alt: OPNFV + :align: left +| +| +====== +PHAROS +====== + +Pharos is the OPNFV Lab Infrastructure project. + +The **Pharos Project** deals with developing an OPNFV lab infrastructure that is geographically and technically diverse. +This will greatly assist in developing a highly robust and stable OPNFV platform. Community labs are hosted by +individual companies and there is also an OPNFV lab hosted by the Linux Foundation that has controlled access for key +development and production activities. The **Pharos Specification** defines a "compliant" deployment and test +environment. Pharos is responsible for defining lab capabilities, developing management/usage policies and process; +and a support plan for reliable access to project and release resources. Community labs are provided as a service by +companies and are not controlled by Pharos however our goal is to provide easy visibility of all lab capabilities +and their usage at all-times. + +* Pharos introduction https://www.opnfv.org/developers/pharos +* Project Wiki: https://wiki.opnfv.org/pharos +* Project Repository: https://gerrit.opnfv.org/gerrit/#/q/pharos +* Continuous Integration https://build.opnfv.org/ci/view/pharos/ + +.. toctree:: + :maxdepth: 3 + :numbered: 3 + + ./information/index.rst + ./lab-description/index.rst + ./specification/index.rst + + +Indices +======= +* :ref:`search` + +Revision: _sha1_ + +Build date: |today| diff --git a/docs/information/index.rst b/docs/information/index.rst index 4af40a59..c9854e87 100644 --- a/docs/information/index.rst +++ b/docs/information/index.rst @@ -1,5 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +************************** Pharos Project Information -==================== +************************** .. toctree:: :maxdepth: 2 diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst index b2c6b1a5..6eb22834 100644 --- a/docs/information/pharos.rst +++ b/docs/information/pharos.rst @@ -1,5 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + +.. OPNFV Pharos Project Information file. + + + +======================================== Pharos Project: OPNFV Lab Infrastructure -######################################## +======================================== The **Pharos Project** deals with developing an OPNFV lab infrastructure that is geographically and technically diverse. This will greatly assist in developing a highly robust and stable OPNFV platform. Community labs are hosted by @@ -32,8 +41,8 @@ Communication Community Test Labs -------------------- -A map of OPNFV lab locations, lab owners and other individual lab information is maintained on the **Wiki** - +An interactive map of OPNFV lab locations, lab owners and other lab information is maintained on the Pharos **Wiki** + +----+---------------+----------------------------------------------------------+----------------------+ | | Hosting | Home page | Location | @@ -41,7 +50,7 @@ A map of OPNFV lab locations, lab owners and other individual lab information is +----+---------------+----------------------------------------------------------+----------------------+ | 1 | Linux | https://wiki.opnfv.org/get_started/lflab_hosting | Portland, Oregon | | | Foundation | | | -+--- +---------------+----------------------------------------------------------+----------------------+ ++----+---------------+----------------------------------------------------------+----------------------+ | 2 | Cable Labs | Internal use only at present | Denver, Colorado | | | | | | +----+---------------+----------------------------------------------------------+----------------------+ diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst index fe84b885..9f2b3822 100644 --- a/docs/lab-description/index.rst +++ b/docs/lab-description/index.rst @@ -1,5 +1,11 @@ -Pharos Project Information -==================== +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +**************************************** +Pharos Templates and Configuration Files +**************************************** .. toctree:: :maxdepth: 2 diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst index 4ea0b124..5b52baf0 100644 --- a/docs/lab-description/lab_description.rst +++ b/docs/lab-description/lab_description.rst @@ -1,3 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +=============================== Pharos Lab Description Template =============================== diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst index a3fed8c3..c44f1162 100644 --- a/docs/lab-description/pod_description.rst +++ b/docs/lab-description/pod_description.rst @@ -1,3 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +=================================== Pharos Lab POD description Template =================================== diff --git a/docs/specification/hardwarespec.rst b/docs/specification/hardwarespec.rst index b42ecf63..80987ce7 100644 --- a/docs/specification/hardwarespec.rst +++ b/docs/specification/hardwarespec.rst @@ -1,3 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + Pharos compliant environment ---------------------------- diff --git a/docs/specification/index.rst b/docs/specification/index.rst index 39764efe..efa0bf44 100644 --- a/docs/specification/index.rst +++ b/docs/specification/index.rst @@ -1,5 +1,11 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +******************** Pharos Specification -==================== +******************** .. toctree:: :maxdepth: 2 diff --git a/docs/specification/jumpserverinstall.rst b/docs/specification/jumpserverinstall.rst index 7b105785..8400c2ab 100644 --- a/docs/specification/jumpserverinstall.rst +++ b/docs/specification/jumpserverinstall.rst @@ -1,4 +1,10 @@ -**Jump Server Configuration:** +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +Jump Server Configuration +------------------------- **Fuel** diff --git a/docs/specification/networkconfig.rst b/docs/specification/networkconfig.rst index 510ea802..7eb0615c 100644 --- a/docs/specification/networkconfig.rst +++ b/docs/specification/networkconfig.rst @@ -1,3 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + Networking ---------- diff --git a/docs/specification/objectives.rst b/docs/specification/objectives.rst index 4d7c1199..310959f4 100644 --- a/docs/specification/objectives.rst +++ b/docs/specification/objectives.rst @@ -1,3 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + Objectives / Scope ------------------- diff --git a/docs/specification/remoteaccess.rst b/docs/specification/remoteaccess.rst index e91d55e1..cb0ad8e2 100644 --- a/docs/specification/remoteaccess.rst +++ b/docs/specification/remoteaccess.rst @@ -1,3 +1,8 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + Remote management ------------------ -- cgit 1.2.3-korg