summaryrefslogtreecommitdiffstats
path: root/docs/userguide
AgeCommit message (Collapse)AuthorFilesLines
2016-09-19WIP: Created 2 introduction documents for user guide and installationSofia Wallin10-300/+59
Work on the contant in both installation and user guide Started to add artifacts in the installation instruction and user guide This is a first draft of the installation.introduction.rst and userguide.introduction.rst. Some of the information has been reused from the Brahmaputra docs with modifications. Please comment and add as needed/wanted. Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit e042f556c6c25858f328cb6287c164b2514a2561)
2016-07-22Modified the templates for the C releaseSofia Wallin1-5/+10
We are getting there.... Change-Id: I8cdf4b2a642a653b0eaa48acf8a7e46bf4a2f98d Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-07-04Establishing document structures for Colorado.ChristopherPrice5-29/+0
Derived from converging patches 16165, 16047 & 15937 into one patch. Change-Id: I3c544ba2fa30856a50274bad9342a06eebc39d58 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> Co-Authored-By: Sofia Wallin <sofia.wallin@ericsson.com>
2016-02-25Final edits.ChristopherPrice1-14/+15
Change-Id: I3125c7d63dcbd46bc5595269fb15ed3d4454f8b5 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-25Final editorials on release morning. Comment here!ChristopherPrice1-2/+2
Change-Id: Ifbd43732a5282e63d9699dfc08b8e5b072c3b040 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-24please review, updates for release.ChristopherPrice1-9/+8
Updated scenario matrix for the user guide. Updated config guide Change-Id: Ic1e55cacab47521c2428748e00458425c32a11af Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-23Including additional projects, aligning test content.ChristopherPrice1-7/+9
Change-Id: I0d3569996ca39a3952c248f1fdd8dc8e8c8963be Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-16User guide updated for automated content inclusion.ChristopherPrice7-17/+26
Editorial done on heading levels and overall content. Still a work in progress, but this is a good milestone to push. Change-Id: I49e0ee4d16ae87cc91bea62959ff7b2a56d5d757 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-15script: gather user guides automaticallyRyota MIBU2-9/+2
Change-Id: I80d0666c4eca809bba42a5cf03d294c4c05bdf99 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-10Made some edits to the ONOS documentationAshlee Young1-7/+10
Change-Id: I3e9ad207d3421582d0ec70ae36cc5d28ea9889ea Signed-off-by: Ashlee Young <ashlee@wildernessvoice.com>
2016-02-09userguide: add new templateRyota MIBU2-0/+12
This patch adds new template 'testusage.rst' and 'featureusage.rst' in the same manner of configguide. This makes us easier to compile files into correct places. Change-Id: I1aaacb07098b068f42b0f7b7cd1f724de617c932 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-05Adding general component descriptions and information.ChristopherPrice8-39/+133
Change-Id: Ie9824ac9c706f730c929a5ca0ed34ee85314719e Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-04Add ipv6 docs entries in feature-config.rst, post-install.rst, userguide.rst ↵Bin Hu1-0/+1
and build-composite.sh Change-Id: I3783c30d4adfe4ebe913cfeeace3e76d5bb57f38 Signed-off-by: Bin Hu <bh526r@att.com>
2016-02-03Small update for apex and setting some info on component, to be completed.ChristopherPrice3-0/+12
Change-Id: I78711a79ae483a0f1abc49a154cf0360e3ebf6d8 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-03Adding new projects content and license information.ChristopherPrice12-14/+81
This includes content from a variety of projects participating in Brahmaputra. We need to move to editorial work shortly, establishing a consistent style now that we have sufficient content in place to work with. Change-Id: I3a54358186ec788bf8cb60b2e44517c36ff53fa2 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-02fix section headers in consistent ruleRyota MIBU9-13/+13
'*' with overline: document title (placed before toctree) '=' with overline: sections '=': subsections '-': subsubsections Change-Id: Ia91ec0c4f95185eac911e972a07ebc7fdae372f4 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-01Updating scripts including composite doc input.ChristopherPrice1-0/+3
Added functest repo to include validation text in userguide and configguide. Also updated the script based on Ryota's input https://gerrit.opnfv.org/gerrit/8849 Ready to merge although another patch will be needed once the toolchain is in place to continue to integrate content. Change-Id: I4d7adbd174cea29aada99fcdbd42d4c182456739 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-28Including text and graphic placeholders for the user and config guides. (I ↵ChristopherPrice7-13/+71
like apostrophes'') This patch contains the introduction and framing text for the user and config guide. Work is required to add the scenario/feature mapping section and information. Change-Id: I71c9fa7cfbac2d0100c743a8855df4a02cc7482c Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-20Renamed config-overview to userguideSofia Wallin1-0/+0
Change-Id: Ie8e4806686a251ee45e11a8b0447edd6a7407168 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-20Added template for config-overviewSofia Wallin1-1/+1
Added template for config-overview to be used by the featuers. Change-Id: I4ed713bb1b4a257a70cba7a6ed51d6f71feb3bcd Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-20Added template for config-overviewSofia Wallin1-0/+7
Added template for config-overview to be used by the featuers. Change-Id: Id9d63af4f3f6ab469243800982e46aad236c2030 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-01-19Updating the index.rst file to include referred content.ChristopherPrice3-27/+24
Adding new committers in the INFO file. This patch includes updates to the index files to establish the correct structure for the composite docs in Brahmaputra. The patch also includes an updated INFO file adding Ryota Mibu and Sofia Wallin as committers to the project. add the include references. Change-Id: Ife98bd25ac3c80d2737132867449ee11f45a581e Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-08Small editorial changes to the template documents.ChristopherPrice8-34/+51
Added reference sections without local placeholders. Restructured the user-guide index template. Change-Id: I8b2e6abbe151a8fb9f3721e761a65f70fada1e85 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-07Use auto project links generated by jenkinsRyota MIBU2-3/+3
Note: https://gerrit.opnfv.org/gerrit/5767 is needed for this change. Change-Id: I809edabea89129d9472852ceb07c323be97bdf45 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-07Use include directive to include project docs in opnfvdocsFatih Degirmenci1-2/+7
Change-Id: I7d70348cea93dddaeefc251554cbe564f8720c40 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-12-28Merge "Updated the config guide templates"Christopher Price1-3/+29
2015-12-28Updated the config guide templatesSofia Wallin1-3/+29
Updated the config guide templates.Some sections still need work. Please feel free to change/add or update where needed. Change-Id: Iaec8616a0d808a7b2c2f72433c630a36afaf4703 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-18Fix Line Length etc for existing docsUli Kleber1-1/+2
Jira: DOCS-68 Fixing errors reported by the new tooling. platformoverview/index.rst will be fixed with the new platformoverview document (see separate patch) corrected importing logo images Change-Id: I08f73dcfeef4f2ff3a38a0372491a46798b4026b Signed-off-by: Uli Kleber <ulrich.kleber@huawei.com>
2015-11-24JIRA: DOCS64ChristopherPrice2-0/+29
Adding three test files to establish the cross repository workflow and build out the templates for the Brahmaputra release documents. Change-Id: I9afdaccfae5e583fdca43789ee65940f83514d34 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>