summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2016-02-17Merge "Next step platformoverview doc"Ryota Mibu5-59/+103
2016-02-16Next step platformoverview doculik5-59/+103
Jira: DOCS-42 Added the license Transformed introduction to more fluent text. Created new and shorter component intro for ONOS as an example. Similar intro for other components needs to be done. Change-Id: Idf8afe4a1255031010dbf00830f845efa96b377f Signed-off-by: ulik <ulrich.kleber@huawei.com>
2016-02-16User guide updated for automated content inclusion.ChristopherPrice8-17/+27
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-16correct file path in imported rst filesRyota MIBU2-3/+12
Change-Id: I2d3a784dd3fcd41b2ba637cef633a4cf42ebadae Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-16Revert "introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@"Ryota MIBU1-12/+4
This reverts commit 00abc9dc015c881138a2790a9757c58bb3d85255.
2016-02-15introduce @OPNFVDOCS_PATH@ and @PROJECT_PATH@Ryota MIBU1-4/+12
Change-Id: Icc3fcf36746e70dc0ec41826aa2e2fc3d86db2f1 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-15script: gather user guides automaticallyRyota MIBU3-12/+5
Change-Id: I80d0666c4eca809bba42a5cf03d294c4c05bdf99 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-15script: gather installer config guides automaticallyRyota MIBU5-34/+9
Change-Id: Ib69f029ec5673e94d16b54df46952c5f17cfd5aa Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-12script: fix auto feature config builderRyota MIBU2-11/+16
Change-Id: Ifa7249ceed9f803e3bb7fbe79caa05705e7fd42f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-11WIP: script: gather feature config guides automaticallyRyota MIBU7-55/+26
Change-Id: Iedc50c723ee3ec0fa0e07848d633d35c67d5aa94 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-10Merge "Created a templamte for release note."Sofia Wallin2-0/+146
2016-02-10Created a templamte for release note.Sofia Wallin2-0/+146
Change-Id: I67ebce045ffcc26643d44a73dd8924d6fb1ee326 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.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-08configguide: make sections relevant by adding sub-level toctreeRyota MIBU17-14/+107
This patch wrap each import document with 'toctree' directive so that we can make sure the sections in imported docs won't take any upper level section. This patch also fixes the followings: * path to copper/featureconfig.rst * path to promise/configguide/images/ Change-Id: I52d4e9cd637af5707af418ef287d57d8c301b85e Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-05Adding general component descriptions and information.ChristopherPrice11-41/+154
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 Hu4-0/+4
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.ChristopherPrice4-1/+13
Change-Id: I78711a79ae483a0f1abc49a154cf0360e3ebf6d8 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-03Adding new projects content and license information.ChristopherPrice26-27/+148
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-03add copyright in build scriptRyota MIBU1-0/+8
Change-Id: I8e2045a50fc283842ab2476b9411eb2c212145d4 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-02fix section headers in consistent ruleRyota MIBU21-69/+32
'*' 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.ChristopherPrice4-8/+15
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 ↵ChristopherPrice14-14/+206
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-28Platformoverview structured in separate files per section and added some contentulik6-180/+250
Jira: DOCS-42 Next step to create platform overview document. Proper use of index.rst, separate files per major section. Started to provide content. Change-Id: I542ae1ed334d9832bbed24926213ce651d2ae4ce Signed-off-by: ulik <ulrich.kleber@huawei.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.ChristopherPrice9-48/+55
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-14Reverting the reffered file reference to direct manual additions.ChristopherPrice1-8/+4
Removed the generated file refernce in the index.rst file and referring to each project file specifically in the index.rst file. Change-Id: I00eba02a292d74b2959fa071db3a7e857ce06300 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-01-13composite docs: remove creation of other projects docsRyota MIBU1-1/+4
Change-Id: I73fa92f3fd782920486e364818b69e12974f4292 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-13composite doc: limit project to importRyota MIBU1-2/+8
Change-Id: Ie358ef46d9bd46e66e4562e05b0fec20b3f1d3c2 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-08Small editorial changes to the template documents.ChristopherPrice9-42/+55
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-08fix docs builder scriptRyota MIBU1-0/+1
Change-Id: Idf58d22ea0db6835c7d71570fdd2a413de3c6fc3 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-08fix args for git-clone in build-composite.shRyota MIBU1-1/+2
This patch also adds xtrace for debug. Change-Id: Ic0642f31ba256ea768f7e7c3a767d2bd3f7f3ba8 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-08update docs build dir names in .gitignoreRyota MIBU1-2/+2
Change-Id: Ia0182184ea8e2fa528d7ffaba9beaf39e5768be1 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-07add build-composite.shRyota MIBU1-0/+57
Change-Id: I82440989202c8b0f5ff36b54965f3269c3ff2d66 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-01-07Use auto project links generated by jenkinsRyota MIBU4-6/+6
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 Degirmenci2-7/+9
Change-Id: I7d70348cea93dddaeefc251554cbe564f8720c40 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2016-01-05Adding template files for the configguide composite documentChristopherPrice5-14/+74
Added the feature configuration and post install/config template files for use in the composite configguide document. Fixed trailing whitespace, and added ./ specificity to the local doc references. Change-Id: I7778993d01d978b60d46375b334d59dbdc2b855a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-12-28Merge "Updated the config guide templates"Christopher Price4-9/+44
2015-12-28Updated the config guide templatesSofia Wallin4-9/+44
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-18Merge "Fix Line Length etc for existing docs"Christopher Price18-72/+174
2015-12-18Fix Line Length etc for existing docsUli Kleber18-72/+174
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-12-18Merge "Skeleton and first draft content platformoverview"Christopher Price2-7/+176
2015-12-18Merge "Created a template for installer configuration"Christopher Price1-0/+23
2015-12-17Created a template for installer configurationSofia Wallin1-0/+23
Change-Id: I1accfa33b28b00724e175b1e08a5cd34c1d85245 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2015-12-17Skeleton and first draft content platformoverviewUli Kleber2-7/+176
Jira: DOCS-42 Skeleton is showing, which sort of content is expected. Some content could already be provided, in other cases there are Editor's notes describing the way to go. worked on comments. mistake in index.rst fixed Change-Id: I075dc20398a87087910cb2d997db51f30f2d12e0 Signed-off-by: Uli Kleber <ulrich.kleber@huawei.com>
2015-12-11Merge "updates to use new doc toolchain"Christopher Price3-35/+5
2015-12-11updates to use new doc toolchainRyota MIBU3-35/+5
Change-Id: I68bffb1a0803d8aabb95d88ab70e243fb3fc75be Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2015-12-09Adding structure to the Config guideSofia Wallin5-9/+40
Removed content text from the index file. Created content files, added sub sections for installers and features. Change-Id: I630ac62546b6cd8facc793e595f647b5a5d8c45f Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>