summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2016-08-11add version, builddate and copyright in sidebarRyota MIBU2-0/+4
Change-Id: I652de718ebc1084230499eb7bc19e2fd9ab90159 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-12Merge "Creating a template for feature projects to produce userguide and ↵ChristopherPrice4-0/+90
scenario description documents"
2016-08-11Creating a template for feature projects to produce userguide and scenario ↵ChristopherPrice4-0/+90
description documents This template will be pushed to features projects in Colorado to help them create the right documentation for the Colorado release. The documentation will be feature and scenario specific at a level where that makes sense while allowing common activities like instalation to be handled in documents for the installation tools. Change-Id: I649c583233ab8d8f8c3ebf7ddf8ae539dae15c8a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-08-11fix workaround for doc8 errorRyota MIBU1-1/+2
Change-Id: I7c31f042f5fb02d1294e4a72aef872f153c55755 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-12Merge "remove 'Save to PDF' link from normal HTML pages"Ryota MIBU1-1/+3
2016-08-11workaround for doc8 error in python2.6Ryota MIBU1-1/+7
Change-Id: I9b8967e564b522354f6fdcea51fe493c9682d36f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11remove 'Save to PDF' link from normal HTML pagesRyota MIBU1-1/+3
'Save to PDF' should be appeared in single HTML pages. JIRA: DOCS-156 Change-Id: I4566a976a8590a521bff4d0038597421f367f8e3 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11add 'Save to PDF' link in sidebarRyota MIBU2-0/+25
Change-Id: Ia9ffd10aa73c9e39203f31a5a19329006b68a444 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-10use doc8 in virtualenvRyota MIBU2-4/+5
Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68 JIRA: DOCS-152 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-10add creation of singlehtml for downloadable docsRyota MIBU1-0/+12
Change-Id: I4e7b188f43d69866fa5f42b4393e92f91cd795a2 JIRA: DOCS-156 Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org> Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-27Merge "Updating the scenario installation template based on comments."ChristopherPrice5-695/+33
2016-07-26Updating the scenario installation template based on comments.ChristopherPrice5-695/+33
Commets from https://gerrit.opnfv.org/gerrit/#/c/16837 adressed. Change-Id: I83a58c5ec6088805a8670bc7801351d33c6e5fa8 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-07-25remove build-composite.shRyota MIBU1-11/+0
The contents in build-composite.sh were already moved to docs/pre-hook.sh . After jjb was updated to use scripts/docs-build.sh instead of build-composite.sh , we can remove it. Change-Id: Icbffed34a281a9119dca57d26a003fd2f0791731 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-25fix pre-hookRyota MIBU2-2/+9
- execute pre-hook after required python package installed - remove execution flag of docs/pre-hook.sh as it's unnecessary - add howto document regarding 'Hooks' Change-Id: Ib94888b018347ce8660d53db93dba3586c098948 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-22support pre-hook in docs-build.shRyota MIBU3-115/+127
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 MIBU3-55/+49
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-20fix bug in build-composite.shRyota MIBU1-1/+1
Change-Id: I9dd5ac9037c7a473e5ae2229481a9bb7811b3101 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-11Merge "Updated according to Chris comment Minor updates to the structure"Sofia Wallin2-1/+1
2016-07-08Updated according to Chris commentSofia Wallin2-1/+1
Minor updates to the structure Change-Id: I86a2b286a522dd5e633da6dfd9133da2e7dbc7a4 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-07-08fix to use docs-build.sh in opnfvdocsRyota MIBU1-3/+1
Change-Id: I2cabab87e3aaf144b2833bfeb54a8516a612d3c2 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-07migrate docs-build.sh from releng repoRyota MIBU5-13/+293
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.ChristopherPrice33-240/+116
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-12Merge "add bottlenecks and prediction project for composite doc"Ryota Mibu1-0/+2
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-11add bottlenecks and prediction project for composite docMatthewLi1-0/+2
Change-Id: Id13363c135fe0008b9cbbc4d35c264e2e97fa1bd Signed-off-by: MatthewLi <matthew.lijun@huawei.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-03-14Promoting Sofia Wallin to opnfvdocs PTL.ChristopherPrice1-2/+2
Change-Id: I59ff5ecd2f5062383ec0bfdcd7c12f0fc63e5087 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-03-08Removing Malla as a committer in opnfvdocs after standing down.ChristopherPrice1-1/+0
Change-Id: I3c28399a3b0ef770042ff2b72b704e3d45e568a5 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-03-07Removing Ashiq as a committer after he stood down.ChristopherPrice1-1/+0
Change-Id: Ib2bd8e3374d036829568f1565ad1820229a6c87e 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.ChristopherPrice7-85/+62
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.ChristopherPrice14-27/+70
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.ChristopherPrice4-16/+22
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 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.