summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-02-16Merge "User guide updated for automated content inclusion." into ↵Ryota Mibu8-17/+27
stable/brahmaputra
2016-02-16script: fix auto feature config builderRyota MIBU1-0/+2
Change-Id: Ifa7249ceed9f803e3bb7fbe79caa05705e7fd42f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit e0a0a51fd5a903f184be9bf78051b8bec4ab6a2a)
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> (cherry picked from commit 15ceb63b678d748526df434b82616356f97f0d8e)
2016-02-16correct file path in imported rst filesRyota MIBU1-0/+2
Change-Id: I2d3a784dd3fcd41b2ba637cef633a4cf42ebadae Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit 410ae27d228750f1e48f13d89fcbedbdb0708da9)
2016-02-15script: gather user guides automaticallyRyota MIBU2-9/+2
Change-Id: I80d0666c4eca809bba42a5cf03d294c4c05bdf99 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit 8b29f1d89a38a37bfbe6d9a3631f641e11c8694a)
2016-02-15script: gather installer config guides automaticallyRyota MIBU4-30/+1
Change-Id: Ib69f029ec5673e94d16b54df46952c5f17cfd5aa Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit c510e2c65b782cb20895a4fcf79cf2cd30dfbd8d)
2016-02-11WIP: script: gather feature config guides automaticallyRyota MIBU6-40/+0
Change-Id: Iedc50c723ee3ec0fa0e07848d633d35c67d5aa94 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> (cherry picked from commit 6bd42c59ae30c30b460f6e69171e71a4e4f9c541)
2016-02-10Made some edits to the ONOS documentationAshlee Young1-7/+10
Change-Id: I3e9ad207d3421582d0ec70ae36cc5d28ea9889ea Signed-off-by: Ashlee Young <ashlee@wildernessvoice.com> (cherry picked from commit 1cba2564098a29f40292b4ee4b0097c7be2da715)
2016-02-10Created a templamte for release note.Sofia Wallin2-0/+146
Change-Id: I67ebce045ffcc26643d44a73dd8924d6fb1ee326 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit 1248219725b58455f67bcfebbab2e87338b83d57)
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> (cherry picked from commit 07f04d51f3d337d6c5b7ee6f5175dcdbcc30f736)
2016-02-08configguide: make sections relevant by adding sub-level toctreeRyota MIBU16-14/+103
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> (cherry picked from commit b7519539bf10181d248b69486c490df46693b209)
2016-02-07Adding general component descriptions and information.ChristopherPrice10-41/+151
Change-Id: Ie9824ac9c706f730c929a5ca0ed34ee85314719e Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> (cherry picked from commit 58a2bb9407285dbf2bac8e32bd55582379c49a6a)
2016-02-05Add ipv6 docs entries in feature-config.rst, post-install.rst, userguide.rst ↵Bin Hu3-0/+3
and build-composite.sh Change-Id: I3783c30d4adfe4ebe913cfeeace3e76d5bb57f38 Signed-off-by: Bin Hu <bh526r@att.com> (cherry picked from commit 3f9b7e0eebea5599b3393d92f3220c2d0827c5ac)
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> (cherry picked from commit 16bfe0d50a6945ea0ff0a3858439346df2f9c892)
2016-02-03Adding new projects content and license information.ChristopherPrice25-27/+145
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> (cherry picked from commit f0e8daeff47cf716109945f277ba635f6c8e7a55)
2016-02-01fix 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> (cherry picked from commit 9351f9aed9383b85173215cf892eef5b3fc44fc3)
2016-02-01Updating scripts including composite doc input.ChristopherPrice2-0/+4
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> (cherry picked from commit 145ed01de3d50f82a9ed25ec1421651b8248df63)
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.ChristopherPrice7-47/+49
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-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-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 Price2-35/+0
2015-12-11updates to use new doc toolchainRyota MIBU2-35/+0
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>
2015-11-24JIRA: DOCS64ChristopherPrice6-0/+89
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>
2015-11-10Added opnfv-security-guideLuke Hinds14-0/+169
Modified conf.py to include RTD theme.... html_theme = 'sphinx_rtd_theme' Change-Id: I9b004725ba4ca6606ad8b9e8700f4395ccdeafaa Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
2015-11-10Move documents to new directory structureAric Gardner9-0/+102
added index.rst Change-Id: I5af95b40afd5443176c1054085b597a435c31b1b Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-09-13Updatng the doc tracking text to show _sha1_ and _date_ as required in the ↵ChristopherPrice1-5/+2
rst files. JIRA: BGS-48 Change-Id: I6dfd566af582d8da416065f7e4db728076d62a12 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2015-07-24Add syntax highlighting for bash blocksAric Gardner2-3/+7
Also remove some []'s that were casuing rst2pdf to intepret a line as an ipv6 url Change-Id: I5e0cd0d455cc25e24853c37ac9329394c763828d Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2015-05-27Test docu-build.sharno.2015.2.0arno.2015.1.0stable/arnoFatih Degirmenci1-1/+1
JIRA: OPNFVDOCS-XXX Change-Id: I1f1b349fe8f80d6d5c9c8fbbc9750cf92e78a51a Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2015-05-25Small fix for sed _sha1_ and _date_ replacementVictor Laza1-5/+16
JIRA: DOCS-35 - Added also a comment on how to proceed in the code. Change-Id: I96ce01ea8b4213e5a0dce08792118137a4eed0bd Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-14Update docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning"Victor Laza1-17/+74
JIRA: DOCS-32 - Update docs/enable_docu_gen.rst scripts to include "rst2html --halt=warning" and added a more clear tree structure for repository Change-Id: Iaabce4dcb04464cae1ec6404a6e86aee275e339c Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>
2015-05-11Merge "Add Wiki - how update works in enable_docu_gen.rst"Christopher Price1-0/+6
2015-05-11Merge "Documentation templates for: LICENCE Installation Build Release-notes"Christopher Price4-4/+241
2015-05-05Add Wiki - how update works in enable_docu_gen.rstVictor Laza1-0/+6
JIRA: DOCS-27 - Add Wiki - how update works in enable_docu_gen.rst Change-Id: Ifcf96ffecbffc539a92ea43167ee81f44733f659 Signed-off-by: Victor Laza <vlaza@cloudbasesolutions.com>