From: Trevor Cooper Date: Tue, 19 Jan 2016 19:53:14 +0000 (-0800) Subject: Organized document directories, added index.rst files ... X-Git-Tag: brahmaputra.1.0~12 X-Git-Url: https://gerrit.opnfv.org/gerrit/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F49%2F7349%2F4;p=pharos.git Organized document directories, added index.rst files ... ./ only file here should be project facts (INFO) ./docs/ no files should be here (jumpserver_install and pharos-spec files will be removed) ./docs/configguide/ overview of community lab expecations, reference to all other files wtih descriptions, get started for a new lab (e.g. how to update pharos start page) ./docs/images/ diagrams for pharos project (Wiki etc. not a particular lab) ./docs/information/ contains pharos project information ... pharos.rst ./docs/lab-description/ templates and config file examples (human readable (rst) and machine readable (yaml) files) ./docs/labs/ all lab specific documentation (filled templates, etc.) ./docs/labs/images/ lab specific diagrams ./docs/specification/ files that are part of the pharos spec Change-Id: I3a7a1434ae4b8f6f0d66d0ce5b6a1b00853378d5 Signed-off-by: Trevor Cooper --- diff --git a/.INFO.swp b/.INFO.swp new file mode 100644 index 00000000..a187b76f Binary files /dev/null and b/.INFO.swp differ diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 00000000..4af40a59 --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,15 @@ +Pharos Project Information +==================== + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst + +:Authors: Trevor Cooper (Intel) +:Version: 1.0 + +Indices and tables +================== + +* :ref:`search` diff --git a/docs/lab_update_guide.rst b/docs/configguide/lab_update_guide.rst similarity index 100% rename from docs/lab_update_guide.rst rename to docs/configguide/lab_update_guide.rst diff --git a/docs/information/index.rst b/docs/information/index.rst new file mode 100644 index 00000000..4af40a59 --- /dev/null +++ b/docs/information/index.rst @@ -0,0 +1,15 @@ +Pharos Project Information +==================== + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst + +:Authors: Trevor Cooper (Intel) +:Version: 1.0 + +Indices and tables +================== + +* :ref:`search` diff --git a/docs/pharos.rst b/docs/information/pharos.rst similarity index 100% rename from docs/pharos.rst rename to docs/information/pharos.rst diff --git a/docs/labs/templates/lab_details_template.rst b/docs/lab-description/lab_details_template.rst similarity index 100% rename from docs/labs/templates/lab_details_template.rst rename to docs/lab-description/lab_details_template.rst