summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-08-22Update according DOCSJulien10-19/+40
Each path use a index.rst file to include all the rst files: 1). Add missing index.rst 2). Rename some file to index.rst 3). Ude a index.rst to include all the community labs(currently all the labs are at the top level) Change-Id: I9bb6903328a8d445121982dd662df9eeceb23ff5 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2016-08-17Merge "update OOL lab description"Jack Morgan9-190/+424
2016-08-10update OOL lab descriptionRyota MIBU9-190/+424
- add description of 'ool-virtual1' - use the new template Note: missing information will be updated by OOL admin in another patch. JIRA: PHAROS-231 Change-Id: If31baba1b072f56745e9c9e8798eea5289996a3a Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-09Add zte-pod2 info in documents1001396811-373/+363
Update the documents structure to describe 2 PODs in ZTE NJ Pharos Lab: Update the template; Update zte-pod1 informaton; Add zte-pod2 information; Add zte-nj.rst into index.rst JIRA: PHAROS-235 Change-Id: Ib06e2d0c247a260e4c64909b90d2b33b32bc9dc6 Signed-off-by: Julien-zte <zhang.jun3g@zte.com.cn> Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-08-04ZTE SH Lab documentsJulien7-1/+303
Add ZTE SH Lab information into documents JIRA: PHAROS-228 Change-Id: I4d9594b0a1a127cef5118bdb2a1f343185f97cb5 Signed-off-by: Julien-zte <zhang.jun3g@zte.com.cn>
2016-08-04Merge "Update the Pharos template"Daniel Smith3-57/+57
2016-07-30Add community labs information intoJulien4-0/+21
Add community labs information alphabetically into release documents. Add orange_**paris path** and organge_paris.rst, so that the lab and pod documents can be shown in the same chapter of the release document. JIRA: PHAROS-241 Change-Id: I9fcfaf89cd652c86d84a56e7a948c04a3c158d29 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2016-07-29Update the Pharos templateJulien3-57/+57
Reduce the width of table for easier reading, Update the minor char changes JIRA: PHAROS-29 Change-Id: I7a3fe8dd73a46d7866c022fbbd93f41d373eeef0 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
2016-07-27Reformat the rst documents1001396819-1056/+1101
Main changes: Set the textwidth to 100, exceptions: tables and http links may be longer than the limits Cut off the table width as shorten as possible JIRA: PHAROS-227 Change-Id: I07861e675d76ab5063f388d3be7d0b51c8bad38b Signed-off-by: 10013968 <zhang.jun3g@zte.com.cn>
2016-07-27Merge "Add pod description and topology graph of ZTE testlab."Daniel Smith2-0/+114
2016-07-27Merge "Create lab-description.rst file of zte pod."Daniel Smith1-0/+67
2016-07-27Merge "Update the wiki page link"Daniel Smith4-63/+70
2016-07-19Add detailed configuration steps to Jump serverJulien-zte1-6/+21
Add more information for configuration the Jump server 1. bridge interface 2. sshd 3. nameserver JIRA: PHAROS-78 Change-Id: I9e30828f95c2d338ebbb0050424fef5a91afe916 Signed-off-by: Julien-zte <zhang.jun3g@zte.com.cn>
2016-07-19Update the wiki page link100139684-63/+70
OPNFV community changes wiki toolchain from dokuwiki to confluence, which causes most of the links are changed. Most of wiki page links in pharos documents are unvlid any more esp. these pharos lab links. JIRA: PHAROS-226 Change-Id: Ic64e90a829fc1e1f6b849439cf7fef134e39484a Signed-off-by: 10013968 <zhang.jun3g@zte.com.cn>
2016-06-24Merge "Added a Testlab information on OOL"Morgan Richomme3-0/+194
2016-06-15Add OPNFV Orange Paris Community Lab descriptionfdespres3-0/+200
JIRA:PHAROS-58 Change-Id: I7e06f368226d20b842ec7ab3e1c61c92aba09ffa Signed-off-by: fdespres <francois.despres@orange.com> Signed-off-by: Francois DESPRES <francois.despres@orange.com>
2016-05-31Added a Testlab information on OOLchiisaihayashi3-0/+194
modified: information/pharos.rst new file: labs/OOL.rst new file: labs/images/ool-testlab.png Change-Id: Ibc4d7e7ce9b4d8910dd2e921faed0df6aedc29f4 Signed-off-by: Keiichi Kobayashi <abok.1k@gmail.com>
2016-05-27Create lab-description.rst file of zte pod.zhifeng.jiang1-0/+67
Change-Id: I068262b3fc563934975c6df2214f7c14de3a8a77 JIRA: PHAROS-162 Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-05-13Add pod description and topology graph of ZTE testlab.wu.zhihui2-0/+114
JIRA: PHAROS-163 Change-Id: I7f13b6aa62096dc1112744b96f5e291f838c4aee Signed-off-by: wu.zhihui <wu.zhihui1@zte.com.cn>
2016-04-29JIRA: PHAROS-161zhifeng.jiang1-0/+49
Add zte nj pod inventory file. Change-Id: I24d3e9ef45732955260e1fadc8190d1b894b19fa Signed-off-by: zhifeng.jiang <jiang.zhifeng@zte.com.cn>
2016-02-24Moved section on joining Pharos community out of configguide.rst so that it ↵Trevor Cooper2-14/+9
does not appear in overview docs. Change-Id: I7114f561cbeae81a2c8e0c67624e22ae0cc54a22 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-02-24Removed index files from all doc directories, rearranged headings, fixed ↵brahmaputra.1.0Trevor 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>
2016-02-22Various Document edits to fix formatting issues and add contentsTrevor Cooper10-152/+164
Change-Id: I522bf15377fb00cb22e46050ee966884896afeac Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-02-09Formatting docs rev5Trevor Cooper7-14/+51
Change-Id: If230b02f95f6aa6937d18c3d7b5daa2e89664aed Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2016-02-09Fixed link to pharos pageTrevor Cooper14-12/+138
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/
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>