diff options
| author |   Trevor Cooper <trevor.cooper@intel.com> | 2016-01-19 11:53:14 -0800 |
|---|---|---|
| committer | Trevor Cooper <trevor.cooper@intel.com> | 2016-01-22 13:42:03 -0800 |
| commit | c4e926c285db44a5ec5ba4a895c8d3889e3358c0 (patch) | |
| tree | bb37ed035989bcca11e1cbcfe7b3085ad17429cf | |
| parent | 971188744137c6d0dc75cb89740bbb759651d304 (diff) | |
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 <trevor.cooper@intel.com>
| -rw-r--r-- | .INFO.swp | bin | 0 -> 12288 bytes | |||
| -rw-r--r-- | docs/configguide/index.rst | 15 | ||||
| -rw-r--r-- | docs/configguide/lab_update_guide.rst (renamed from docs/lab_update_guide.rst) | 0 | ||||
| -rw-r--r-- | docs/information/index.rst | 15 | ||||
| -rw-r--r-- | docs/information/pharos.rst (renamed from docs/pharos.rst) | 0 | ||||
| -rw-r--r-- | docs/lab-description/lab_details_template.rst (renamed from docs/labs/templates/lab_details_template.rst) | 0 |
6 files changed, 30 insertions, 0 deletions
diff --git a/.INFO.swp b/.INFO.swp Binary files differnew file mode 100644 index 00000000..a187b76f --- /dev/null +++ b/.INFO.swp 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 index fb41f4bc..fb41f4bc 100644 --- a/docs/lab_update_guide.rst +++ b/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 index dc0bcc6a..dc0bcc6a 100644 --- a/docs/pharos.rst +++ b/docs/information/pharos.rst diff --git a/docs/labs/templates/lab_details_template.rst b/docs/lab-description/lab_details_template.rst index bcc909ad..bcc909ad 100644 --- a/docs/labs/templates/lab_details_template.rst +++ b/docs/lab-description/lab_details_template.rst |