summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-01-15Add new templates for docs contributionShubhamRathi26-0/+500
Adding new templates for docs contribution to be used by the project teams. Templates for 'Testing/' havent been added yet since its not perfectly clear what all cases need to be documented. Change-Id: Id9c1d0d87d99bb071cbcd493817500666cd59b79 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-14Add index with submodulesShubhamRathi1-28/+31
Index page updated to point to feature, testing and installer projects. This is in tandem with the plan to divide documentation in Release, Developer and Testing. Change-Id: I7e54190d402a6c241a358c9e13ce477d496f23a3 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-12Add conf.py, static filesShubhamRathi5-0/+278
Adding new conf.py & static files that shall be used to render docs. As part of the move to read the docs, intent is to have a single static conf.py at the root which shall manage the themeing etc. Change-Id: I71aedd1268649889e7e8c1e357fd3860f08ae390 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-11Add submodules and .gitmoduleShubhamRathi44-1/+1
Adding submodules of all OPNFV projects in order to create a unified repository for documentation. By using submodules we will be able to maintain a single conf.py file and theme to be used across all projects Change-Id: I65ec1a85f074f142bc335e8611e9636b5e4cb3a9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2016-11-24Adjusted the docs repo structure for D release workSofia Wallin52-924/+37
Change-Id: I9befe06c424c726e17d754bc480413b2430549ba Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-11-23New file for the readthedocs rendered.ChristopherPrice1-0/+10
This is a placeholder to test the toolchain. Change-Id: Ib3eb61632e812369e6da6706a7ff8fe20a43c547 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-11-15Merge "Add figure for Testing Ecosystem"Sofia Wallin2-1/+3
2016-10-25Colorado 2.0 updatesSofia Wallin4-127/+124
Updated according to comments All links updated for colorado 2.0 Link fixed in the overview doc according to Jira ticket DOCS-161 Change-Id: Ib3ff5f1159c45c6dc45601360e4e31a5210a15ec Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-09-23Last minute adding LXD scenario docsChristopherPrice1-0/+2
Change-Id: I530c2e01b03b49bfde4d4b10b353451c5d56fdbd Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-22Add figure for Testing EcosystemMorgan Richomme2-1/+3
Change-Id: I7f71ff607e281e8991821fc9543f787d809d6b19 Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
2016-09-22Final Colorado 1.0 update for the release documentation libraryChristopherPrice1-41/+104
Final version afaict Change-Id: Ib15662ff3608880efdac84b147b9815d58824610 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-22Final versionSofia Wallin3-7/+54
Fixed trailing whitespaces Added StorPerf, this should prob the last link to add. Adding more document links. Added security notes Added numbering to the user guide Adding the feature configuration parts to the user guide. Change-Id: I2b1569c97507be18bd0ec17fab41eeb2554726e5 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-09-20Final version of the release document list.ChristopherPrice1-57/+46
Updated with all Colorado release links. Change-Id: Ia02b0add393a1af414d4c28a13e173a35077b134 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-19Draft of the overview doc.ChristopherPrice7-444/+291
Change-Id: I13d4230591055c5e8c1f4daa469a6bf71993856e Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-19WIP: Created 2 introduction documents for user guide and installationSofia Wallin27-1165/+148
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>
2016-09-15A compact version of the documentation library.ChristopherPrice1-0/+157
This document provides a master branch link to all Colorado related documentation. The patch to Stable will update all release links to /colorado/docs/ but for the time being this document should remaina accurate on master. Change-Id: I47feb62980311f6f76ddc44ef6e46a0999690a8f Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-01Adding creative commons license info.ChristopherPrice1-2/+0
Cannot build a reference until it's merged I guess, Ryota can you make sure this is not broken? Change-Id: Ibc7d98287cb513b894ae79f53864f654959de39a Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-08-24Merge "remove pfd/odt creation"Sofia Wallin1-43/+8
2016-08-19Created a template for feature configurationSofia Wallin1-0/+21
Updated according to comments. Any more information or steps neeeded please add. Change-Id: Ibd3685252f7ae0fe236f36ee640b3424f0761fb5 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
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-11remove pfd/odt creationRyota MIBU1-43/+8
This patch also adds description of html_sidebars in how-to doc. Change-Id: I904ceca3847a085754aacc8d0d0a388f2606c880 JIRA: DOCS-156 Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org> Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-10use doc8 in virtualenvRyota MIBU1-0/+1
Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68 JIRA: DOCS-152 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
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-25fix pre-hookRyota MIBU1-0/+8
- 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 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>