summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2016-07-22support pre-hook in docs-build.shRyota MIBU1-0/+112
Some projects need special pre steps before executing docs-build.sh . For instance, opnfvdocs needs to download other repos which will be composited. Also, apidoc creation is needed during docs build in yardstick. In order to support such cases, this patch introduces pre-hook in docs-build.sh that provides much flexibility to projects and simplifies job definition in releng. Change-Id: If9f26c490671ec0788dc48dd4fccb4513d0ca777 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-22improve configRyota MIBU1-3/+2
A developer was asked to copy all contents in the base config file in order to set all parameters properly, even if the change is partial. This patch improves this config by setting all default parameters based on users' custom config file, so that they can write parameters just which they want to change. Change-Id: Ide459c8e9f416b29b114a4bf2a432e8eae1f841e Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-22Modified the templates for the C releaseSofia Wallin8-31/+44
We are getting there.... Change-Id: I8cdf4b2a642a653b0eaa48acf8a7e46bf4a2f98d Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-07-20Creating a template scenario installation file for Colorado.ChristopherPrice12-0/+1330
Aside from my likely copywright infringements, please review/comment. The basic idea is we create a "master" versions for each colorado installer then each scenario derives from the master files to produce their own. The template is intentionally modular for that purpose. Change-Id: Ic5ca72ece8eb462e6e6e7307d3cde32ea7760b23 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-07-11Merge "Updated according to Chris comment Minor updates to the structure"Sofia Wallin1-0/+0
2016-07-08Updated according to Chris commentSofia Wallin1-0/+0
Minor updates to the structure Change-Id: I86a2b286a522dd5e633da6dfd9133da2e7dbc7a4 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-07-07migrate docs-build.sh from releng repoRyota MIBU1-13/+13
JIRA: DOCS-153 Change-Id: I568192dbb6653eb8fd8518abebf3558dc00dcee8 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-06Merge "update howto use docs"Ryota MIBU1-18/+30
2016-07-04Establishing document structures for Colorado.ChristopherPrice32-235/+110
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-06-30update howto use docsRyota MIBU1-18/+30
Change-Id: I48b4017c5fb012c7119b0685a71320c518694815 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-06-13We had been tracking this in the releng repoAric Gardner2-0/+258
I have removed it from the releng repo This documentation on how to use the document tool chain belongs in opnfv-docs Change-Id: Iad621b394f03511649a1edc21501ca524f0506e4 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2016-05-18Adding additional examples and references to the glossary.ChristopherPrice1-0/+75
Change-Id: I87a7b98891335914de4be2f346b7b932d4da1987 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-05-18Adding a template for the OPNFV common glossary.ChristopherPrice1-0/+42
Added the structure and a couple of examples as a starting point for the OPNFV Glossary. Change-Id: Ic23d784c01d997b2b7d967a54c5d9a4c3e2399c0 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-05-03Added audit related requirement referencesAri Pietikainen3-0/+120
Fixing a typo (cp) Change-Id: Iae41f9e532f72ad0de00c824957d68a513720a18 Signed-off-by: Ari Pietikainen <ari.pietikainen@ericsson.com>
2016-05-02Added Sona's changes on Trusted ComputeLuke Hinds1-6/+120
Updated with commented editorials, want to push this. (cp) Fixed formatting errors. Change-Id: Ia2d5849561d4691d278cc67a6bcdfaec1331de3d Signed-off-by: Luke Hinds <luke.hinds@nokia.com>
2016-04-11Removed the folder "Arno" from the docs repo.Sofia Wallin6-790/+0
Change-Id: Id87d5f81d0883c3d24a07a4ab5de7be4f094a40b Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-04-05Removing an unwanted line from the index file.ChristopherPrice1-2/+0
Change-Id: I2e77de53615c3e7221681f02b8dadcd096b8e343 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-25Final edits.ChristopherPrice2-20/+22
Change-Id: I3125c7d63dcbd46bc5595269fb15ed3d4454f8b5 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-25Final editorials on release morning. Comment here!ChristopherPrice3-2/+12
Change-Id: Ifbd43732a5282e63d9699dfc08b8e5b072c3b040 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-25add links and aodh serviceRyota MIBU4-22/+23
This patch adds links to OPNFV User Guide and OPNFV Config Guide. This patch also add aodh (alarming service) in OpenStack deployed list, since it is aviable in apex with keystone configuration. And, minor fixes. Change-Id: I463683b547a4277c91e397fb14146eaf96c10153 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-25Updating the overview doc with recent comments.ChristopherPrice6-83/+59
Change-Id: I181279f9b0a4330bb98a3e0d40ecb2687d976b92 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-02-24Review and finalize platformoverviewulik4-105/+303
Jira: DOCS-42 Collected all comments. Many comments done, open points marked in commentary (".. text") Patchset 2: resolve most of the comments. Don't merge yet. Change-Id: I3d676a6510ff3c3190110773649265a182b6f762 Signed-off-by: ulik <ulrich.kleber@huawei.com>
2016-02-24please review, updates for release.ChristopherPrice13-27/+69
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.ChristopherPrice3-16/+20
Change-Id: I0d3569996ca39a3952c248f1fdd8dc8e8c8963be Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
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 MIBU1-0/+2
Change-Id: I2d3a784dd3fcd41b2ba637cef633a4cf42ebadae Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.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-15script: gather installer config guides automaticallyRyota MIBU4-30/+1
Change-Id: Ib69f029ec5673e94d16b54df46952c5f17cfd5aa Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-02-12script: fix auto feature config builderRyota MIBU1-0/+2
Change-Id: Ifa7249ceed9f803e3bb7fbe79caa05705e7fd42f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
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>
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 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>
2016-02-05Adding general component descriptions and information.ChristopherPrice10-41/+151
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 Hu3-0/+3
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.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>
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.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>
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>