summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-02-25Moved section on joining Pharos community out of configguide.rst so that it ↵stable/brahmaputraTrevor Cooper2-14/+9
does not appear in overview docs. Change-Id: I7114f561cbeae81a2c8e0c67624e22ae0cc54a22 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit 6732859ab09ddb890ad4c67e2834059f57175bd6)
2016-02-24Removed index files from all doc directories, rearranged headings, fixed ↵Trevor Cooper26-684/+287
broken links and doc formatting issues, created platform overview file, edited content. Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit c8f8facec439fbc4fced0854845070caf9db38a5)
2016-02-24Various Document edits to fix formatting issues and add contentsTrevor Cooper10-152/+164
Change-Id: I522bf15377fb00cb22e46050ee966884896afeac Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit b2231a970fb73f4f5df72b59ed9d58a039644ac3)
2016-02-09Formatting docs rev5Trevor Cooper7-14/+51
Change-Id: If230b02f95f6aa6937d18c3d7b5daa2e89664aed Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit 2fe5f8f73ed6db8c281f251b9fb3a9aad4838fc5)
2016-02-09Fixed link to pharos pageTrevor Cooper14-9/+135
v2: Minor changes to doc text and formatting Change-Id: I50c29118a2b3eeaa1bceb6393ca0e0794a7743ed Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> Added license headers to all doc files Moved master index to docs/ (cherry picked from commit b38808ab6148dcedba64678c5220d178d43a48c4) Change-Id: Ied00c865b1b7bbe70312cd0576e7dbf69ebb7dc1
2016-02-08Fixed link to pharos pageTrevor Cooper1-3/+3
v2: Minor changes to doc text and formatting Change-Id: I50c29118a2b3eeaa1bceb6393ca0e0794a7743ed Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-29White space removed from pharos.rstTrevor Cooper1-5/+5
Change-Id: I914bc172b2815e4720d32bede135ffd5d859b194 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-29Cleaned up docs for toolchain errors.Trevor Cooper2-17/+0
Change-Id: I4d40b58d447671437b2ac8e0ba7f8293c057d204 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> Cleaned up docs for toolchain errors. Change-Id: I4d40b58d447671437b2ac8e0ba7f8293c057d204 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> Fixed doc formatting errors Change-Id: Ice15401d1c09b9a29e163cbec53e72f53d12b294 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> Doc formatting issues fixed Change-Id: Id50e3c93fefa3aed492352db013bad3a827b2877 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-29Cleaned up docs for toolchain errors.Trevor Cooper3-500/+515
Change-Id: I4d40b58d447671437b2ac8e0ba7f8293c057d204 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> Fixed doc formatting errors Change-Id: Ice15401d1c09b9a29e163cbec53e72f53d12b294 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-29Cleaned up docs for toolchain errors.Trevor Cooper4-98/+95
Change-Id: I4d40b58d447671437b2ac8e0ba7f8293c057d204 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-29Updated Dell Lab's Documentation (Trevor fixed merge conflict with Dell.rst)Nauman_Ahad6-1/+502
JIRA: Pharos-68 Test lab documentation updated. Includes information for the third POD that was recently added. Changes to Dell lab images in corespondance to the networking changes made at the lab. Change-Id: Ib040577a40d43acf88f0e76cb4eda08b853cd8b5 Signed-off-by: Nauman_Ahad <Nauman_Ahad@dell.com>
2016-01-28index.rst removed from /docs/configguide and added to /docs/lab-description. ↵Trevor Cooper1-1/+2
These changes were not merged with review 7785. Change-Id: Ifa2402c387778f282ff4de99131eb126c67b57c8 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-28Removed old lab description template and replaced with new template.Trevor Cooper16-525/+572
Updates for ... 1) Lab description 2) POD description 3) Examples of lab tolpology and POD topology diagrams. These files were created using ideas from existing lab/POD descriptions and lab experience for rls B. (cp) provided some tidying up and random spelling fixes for the toolchain. Change-Id: I72a34be9e1c1509fd310b43562bf6d5aa1c459e7 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-01-22Organized document directories, added index.rst files ...Trevor Cooper5-0/+30
./ 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>
2016-01-15Huawei (Santa Clara) OPNFV lab descriptionm001331424-0/+128
JIRA: PHAROS-71 Change-Id: I06c75e2b7aa5eac5930f731458db451260491427 Signed-off-by: m00133142 <meimei@huawei.com>
2016-01-15Merge "Example as code, documentation template for sphinx build"Trevor Cooper4-0/+150
2016-01-15Merge "Updated Dell OPNFV Testlab doc"Trevor Cooper6-356/+378
2016-01-15Merge "Updated Pharos docs to reflect Testlab changes"Trevor Cooper2-2/+3
2016-01-15Merge "Add the ZTE lab information"Trevor Cooper4-0/+244
2016-01-13Created a pharos specification docment according to the new toolchain.ChristopherPrice7-0/+303
Created docs/specification and the index.rst fil in the new format for the new toolchain sequence. Will create a specification/index.html link on artifacts and associate pdf document. Made small editorials to the origincal content, but it needs work. Left the original pharos-spec file as it being worked on still. Should be removed once the spcification docs are in equivalent shape. Change-Id: I6edb121766e7e1fdf1f38c70be95347b81b71dcc Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-11-03Example as code, documentation template for sphinx buildm001331424-0/+150
This code will be pushed to each project creating a docs/ directory This servers as an example and template for you (the developers) to create your own project documentation JIRA: RELENG-15 Change-Id: I603132df92b5f8e9a500786e38639abefadad227 Signed-off-by: m00133142 <meimei@huawei.com>
2015-09-24Add the ZTE lab informationzhifeng.jiang4-0/+244
Add ZTE Nanjing Testlab detailed information. Change the Jump server username to opnfv. JIRA:PHARSO-73 Change-Id: Ia17bf69dad4e203df0535710cdfac4c174863054 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2015-06-07Updated Dell OPNFV Testlab docNauman Ahad6-356/+378
Updated Ip addresses, changed image location within directories so that they could be embedded within the document JIRA: PHAROS-14 Change-Id: I767d52913b09a6ba198a6325a1389f3660836a1f Signed-off-by: Nauman Ahad <Nauman_Ahad@dell.com>
2015-06-04Updated Pharos docs to reflect Testlab changesNauman Ahad2-2/+3
Updated Pharos-spec.rst and phaors.rst to make Dell Testlab information conistent with the rest of the labs JENKINS: PHAROS-18 Change-Id: Ic0be2fa789d2bd285171e3c140194ae8f71dbb94 Signed-off-by: Nauman Ahad <Nauman_Ahad@dell.com>
2015-06-03Fix formmatting of links and auto replacement stringsarno.2015.2.0arno.2015.1.0stable/arnoIldiko Vancsa1-4/+4
Change-Id: I796875410adee86a832323659a3e4e43f91757bc Signed-off-by: Ildiko Vancsa <ildiko.vancsa@ericsson.com>
2015-06-03Minor editsTrevor Cooper1-11/+13
Change-Id: I28e47d5db1abf73789e7a3a124f069187cbdb966 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2015-06-03Amended the text, included the JH instructions inline, updated references.ChristopherPrice1-54/+71
JIRA: BGS-48 Change-Id: I3d239c8d04bbf8f75d110f219678b68dab1ae3b5 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-06-03Clean up and minor editsTrevor Cooper1-12/+8
Change-Id: I585f561fb281d906acecf881ae5040b22e6ed237 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2015-06-03Added link to infrastrcuture naming conventions Wiki page and other minor editsTrevor Cooper1-14/+11
Change-Id: I4c4335e615b4adceffd929b9330acb7fbe8346d8 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2015-06-03Moving the spec.rst file to pharos-spec.rst in order that it is identifyable ↵ChristopherPrice1-0/+0
as a release artifact. JIRA: BGS-48 Change-Id: I333b742a8243b6e00dfb85a40e14418f3bb45adf Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-06-03Updated sections, fixed issues, and added a linkMichael Wynne2-20/+101
In spec.rst changed bullet items/wording in Constraints section, changed Jump Server section and added link to new wiki page that will scrape the artifact generated from the newly added jumpserver_install.rst (resubmitting with removed whitespace) Change-Id: I07b5a49999bf7e24fc160f22b63e467711444882 Signed-off-by: Michael Wynne <michaelx.s.wynne@intel.com>
2015-05-29Merge "Move lab_update_guide under git in .rst format"Trevor Cooper1-0/+72
2015-05-29Added names of people who have admin access to Linux Foundation labTrevor Cooper1-2/+19
JIRA:0000 Change-Id: I1f7326f7e4b5ec2915f8bcaad33b1ed17935a32b Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2015-05-29Merge "Fix tables in lab_details_template.rst"Trevor Cooper1-0/+3
2015-05-29Merge "Lab documentation for Spirent"Trevor Cooper2-0/+41
2015-05-20Added Dell Testlab documentation along with diagramsNauman Ahad4-0/+356
The commit is a first version of the Dell OPNFV testlab document which is made while trying to be consistent with the pharos labtemplate. 3 figures are also included. JIRA: PHAROS-14 Change-Id: Id428f36dfb697a6f6e40d0b6c877b792b53be352 Signed-off-by: Nauman Ahad <Nauman_Ahad@dell.com>
2015-05-15Merge "Fixed improper hyperlinks and renamed the main project file"Trevor Cooper2-103/+104
2015-05-11Lab documentation for SpirentVictor Laza2-0/+41
JIRA: PHAROS-12 - Lab documentation for Spirent Change-Id: I9ea9d02dd502fe70859dafd4edb866d6386a7b56 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-11Fix tables in lab_details_template.rstVictor Laza1-0/+3
JIRA: PHAROS-15 - Fix tables in lab_details_template.rst Change-Id: I8f9463bfe945b61cd5864dba2ecc057f9a39462b Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-11Merge "Adding pharos project spec.rst in docs/"Morgan Richomme6-0/+217
2015-05-07Adding pharos project spec.rst in docs/Victor Laza6-0/+217
JIRA: PHAROS-8 - Adding pharos spec.rst ar request of Trevor including images; all sourced from https://wiki.opnfv.org/pharos/pharos_specification Change-Id: I754c0d34d851bc080113fdb125089bfed9d13760 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-05Move lab_update_guide under git in .rst formatVictor Laza1-0/+72
JIRA: PHAROS-13 - Move lab_update_guide under git in .rst format Change-Id: I5a9e32f05535403cc0e724067f06b360941e04a8 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-05Add template for lab details in pharos projectVictor Laza1-0/+68
JIRA: PHAROS-11 - Add template for lab details in docs/labs/templates/lab_details_template.rst Change-Id: I95e3414e0a48fcf0f702271286000506ffa92238 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-05Fixed improper hyperlinks and renamed the main project fileVictor Laza2-103/+104
JIRA: PHAROS-10 Fixed improper hyperlinks and renamed the main project file from docs/main.rst into docs/pharos.rst Change-Id: I5ab8cd20289c9a3c152b26b643fe539b219ac74e Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-04-09JIRA: DOCU-2 - Added docs/main.rst sourced from https://wiki.opnfv.org/pharosVictor Laza2-0/+103
main.rst has been transformed into .rst using https://wiki.opnfv.org/pharos & standardized the location and naming of documentattion Change-Id: I436567409f3ef4ee8b0b1cc058140b305893c809 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>