From c4e926c285db44a5ec5ba4a895c8d3889e3358c0 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 19 Jan 2016 11:53:14 -0800 Subject: [PATCH] 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 --- .INFO.swp | Bin 0 -> 12288 bytes docs/configguide/index.rst | 15 +++++++++++++++ docs/{ => configguide}/lab_update_guide.rst | 0 docs/information/index.rst | 15 +++++++++++++++ docs/{ => information}/pharos.rst | 0 .../lab_details_template.rst | 0 6 files changed, 30 insertions(+) create mode 100644 .INFO.swp create mode 100644 docs/configguide/index.rst rename docs/{ => configguide}/lab_update_guide.rst (100%) create mode 100644 docs/information/index.rst rename docs/{ => information}/pharos.rst (100%) rename docs/{labs/templates => lab-description}/lab_details_template.rst (100%) diff --git a/.INFO.swp b/.INFO.swp new file mode 100644 index 0000000000000000000000000000000000000000..a187b76f8de638361b5caff07dcf5de88ebd46a9 GIT binary patch literal 12288 zcmeI2&1w`u5P&=4F;P(v#7mo~B;Zbd#V}q*HW4>$eoSIKh=ktR+L_*+=^lH!lgz~& zy!ZfKBoCn%pTdhbAHkPUux57G5GCRz5TP1AdUmV2yZXBgQ>~eu#wvf{EifEc7}Gc2 z?;KtnWxEd^?eY3B zNHZBA17~btjLpx@&Xk8tjNjtdu0A{C^JsfAKnBPF86X2>fDDiUGC&5-lL4EJutO~9 z!l0;|gL&k)dGM1aGC&5%02v?yWPl8i0Wv@a$N(8217zSoG$7iH9gX7mz%eWyzyA;4 z|G!>l>?86PNsxKu$0f!-BOj1=2q2rtQ)C&bA=i=bxYsx23-Sp$Lf#-9WE)vT?jX03 z^4xKR1{oj&WPl8i0Wv@a$N(8217zS_7${sJyG{kM6Z;^mmgZc@o{@R1gxAwH7Qul` zq&n!wyfB6n*_jb7=k;8cxqM%wMUZFGfU;G38&niK8HBM^BGoOKK=nTu849nfW0h+a zNS%02#U8XBOSOrF@-QCjG=)GLp`!kxy0@fN0!0vtRsxA=<<(x#L3O2ycI&YVmX@2% zew|olR1->hg$v5lay+PtblfW`^dA*j1ADsc?k?NHgX8}0I#waA1(W;uMhKbCrPZeJ zdB4w_H8$%$-vYA-#_t#arQ6^su)H4Q>5%vnI#Zp!+8}*ZlrAHl$lP)(BA>tLM_#fO zX$0Rex(lJj89MU7=NnHRZLV*fjID_je7+62Z9$t$)iENs#)Z}y;8}kIHr%KQqK(Pb z?RdSq9iKeqvQxN9rot4MsH_O>zb|ac4unOR0N=90VtEY}x|Xm~t6!zmF%VVm8rVJ` rnJUWfRyRQ>$9V?&p`~i46`@>N)8aioH#2*Gn0Bgx$&IQ5e~SGCn>0Af literal 0 HcmV?d00001 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 -- 2.16.6