summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2017-03-15Updating submodules & add openretrieverShubhamRathi34-0/+0
1. HEAD seems to be out of sync for the submodules This patch fixes the HEAD so that henceforth gerrit automatically updates the refs to latest commit ID. 2. Adding openretriever to list of submodules Change-Id: I341a0a898f46cd10ccdc65ef209f76500dd3c4a6 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-15Merge "Using SPDX shorthand plus a several edits for wordsmithing"Sofia Wallin2-30/+31
2017-03-15Merge "Add Sidebar"Sofia Wallin2-0/+4
2017-03-15Merge "Add git submodule for openretriever"Christopher Price2-1/+10
2017-03-15Add git submodule for openretrieverGuo Ruijing2-1/+10
TODO: there is recursive dependency between opnvdocs and docs in openretrive. submodules in openretriever will be updated in docs/featureprojects.rst after https://gerrit.opnfv.org/gerrit/#/c/28583/ was merged. Change-Id: If9bedf1785a4fcaa138d7d1ef3fc116bba598b03 Signed-off-by: Guo Ruijing <ruijing.guo@intel.com>
2017-03-14Using SPDX shorthand plus a several edits for wordsmithingRay Paik2-30/+31
Change-Id: I1c04abf0d22c49239636ea50ef62e7fd88a03743 Signed-off-by: Ray Paik <rpaik@linuxfoundation.org>
2017-03-14Updated license header with SPDXSofia Wallin1-1/+1
Change-Id: I7fa081f2e3c01f053388ae8f85983abb007ab7f7 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-03-14Merge "Add release notes page"Sofia Wallin2-1/+191
2017-03-13Add SidebarShubhamRathi2-0/+4
Change-Id: I1425eda919f49cbc82d1ab60ef91324d9afee041 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-13Merge "Misc Changes"Sofia Wallin5-74/+69
2017-03-13Merge "updated the license header to use the SPDX shorthand"Sofia Wallin1-6/+6
2017-03-13Misc ChangesShubhamRathi5-74/+69
1. Testing on index page points to <project>/docs/testing/user/index 2. Update all artifact links to RTD using labels 3. 'OPNFV Userguide' renamed as 'OPNFV User Guide & Config Guide' Change-Id: I47837bac86feba0ae6f319b87315d38b4ef3229e Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-10updated the license header to use the SPDX shorthandRay Paik1-6/+6
Change-Id: I0f4e81bafbfdfdb6909a283907a5baa497552622 Signed-off-by: Ray Paik <rpaik@linuxfoundation.org>
2017-03-08Fixed warningsSofia Wallin2-36/+66
Updated structure for test docs Updates done according to agreement with test projects. Change-Id: I2f9b5783ef4e42fd26b357e0aad2e187bcf61777 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-03-08Add release notes pageShubhamRathi2-1/+191
Added new composite document which shall collate all release notes from projects. This document points to release notes of <project>/docs/release/release-notes/index.rst Change-Id: I5c545b3f7c91012131a4d5eeb73842432ce0a51a Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-05Update Templates for TestingShubhamRathi5-0/+0
A directory structure of organizing documents has been maintained in templates/testing without getting into the details of what these templates files should contain. Teams could add whatever documentation they think is necessary while minimally maintaining the basic structure. Change-Id: I2ccf1212acf5b71105cf7a0343705dfaaa95de3a Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-02Update gitmodule fileShubhamRathi1-0/+6
Added branch = . for ovno, snaps & moon. Change-Id: I07ff1693f2e008eb70386a02092b078108aeb9e4 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-02Fixed trailing markupShubhamRathi1-2/+2
Change-Id: I8ce9b278dc3d0d9b376104f753c168ba9a478aa7 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-03-01Merge "StorPerf Documentation"Sofia Wallin1-0/+2
2017-02-27Misc changesShubhamRathi7-6/+16
1. Added onvo, snaps, barometer submodules 2. Renamed a few titles Change-Id: I8b47e68d64a9a16576abbc2891a39b6dacf164ca Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-23StorPerf Documentationmbeierl1-0/+2
Adds link to StorPerf documentation Change-Id: I7d59478792867e47e7627f203015b9a1d716c404 Signed-off-by: mbeierl <mark.beierl@dell.com>
2017-02-22Fixing wrong directory name in documentation guideGeorg Kunz1-1/+1
The directory layout diagram in the documentation guide showed a "developer" directory instead of "development". Change-Id: Ie056a47ebcca65d5307d35543009bfb9c6d0a335 Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
2017-02-21Update OPNFVDocs documentationShubhamRathi3-14/+25
1. Added note about eliminating conf.py etc from include-documentation. 2. Eliminated content about enabling toolchain since its irrelevant after migration to RTD 3. Added steps to validate using doc8 4. Populated index page. Change-Id: I80c8354fd4da4bca0b8f338c178f0773d834b6ee Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-20Adjusted titlesSofia Wallin11-59/+320
Updated according to comments and added the SFC feature configuration as template under release/configguide. Adjusted all titles so they are handled through the index file. Change-Id: Icb0339fb19394940dc969725ddfe0420cb547955 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-02-21Remove moonShubhamRathi1-0/+0
Change-Id: I0b780d41eeb11dae12174cd7e63be1019ba327f7 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-20Remove moon, as they are breaking buildsAric Gardner1-5/+0
Change-Id: Icef338564b07e2fd6e7379697c75624a065ad1b4 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2017-02-20Merge "Add Promise release docs to opnfvdocs"Sofia Wallin1-2/+2
2017-02-17Shallow clone to speed things up for RTDAric Gardner1-0/+43
RTD has a ten minute timeout, this might squeek us in Change-Id: I3d5be51984bd939924b6dfc1d4017bd2a9c1b605 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org>
2017-02-17Add Promise release docs to opnfvdocsGerald Kunzmann1-2/+2
Change-Id: Idbc17af03fe7449ef3e20e198f21338880274dc5 Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>
2017-02-16barometer: add project submodulesMaryam Tahhan1-9/+10
Change-Id: Ie0119fca1cf27731a1f0b9bab824c0133fd55f41 Signed-off-by: Maryam Tahhan <maryam.tahhan@intel.com>
2017-02-13Merge "Added steps to build documentation"Sofia Wallin2-0/+85
2017-02-11Added steps to build documentationShubhamRathi2-0/+85
Added steps to build composite & discreet documentation in include-documentation. Added development in progress label atop index. Change-Id: I28526f157a09e10faf17307445c4d90a3903be03 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-08Documentation guide ported from wikiShubhamRathi2-1/+117
Edited content to enforce the new changes. Added label to include-documentation.rst file which is referenced from the documentation guide. Change-Id: I6e81288062716231ece5934a0be934ed0dbb60dc Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-02-03Merge "New Tox build script"Sofia Wallin2-0/+16
2017-02-03Merge "New docs for 'How to include documentation'"Sofia Wallin2-37/+98
2017-01-31Misc ChangesShubhamRathi11-32/+32
Renamed developer/ to development/ in templates. Corrected chapter level markup in docs/release/ Moved testing above developement in index Change-Id: I950f69bf2ac60e97b260ecfbb4b870a42f8a233b Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-31New docs for 'How to include documentation'ShubhamRathi2-37/+98
This documentation elucidates the revised procedure to include project documentation. Change-Id: Icfcab3a07e386453ae7faf9fa737fe726ff70f0c Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-30Merge "Moving design/ requirements/ to developer"Sofia Wallin4-2/+2
2017-01-30Changing Documentation ThemeShubhamRathi1-1/+1
Documentation theme changed from 'united' to 'journal' Change-Id: I89242a324ea3bd827f829b07f43098d91c225eb8 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-30Moving design/ requirements/ to developerShubhamRathi4-2/+2
design/ & requirements/ were erroneously placed under templates/release earlier. This patch fixes them to templates/developer. Change-Id: I1159c2999c63a4dd8f29e893fab9374e3077f59f Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-30Cleanup old templates and add placeholders where requiredShubhamRathi30-502/+5
Old templates have beem eliminated. Placeholder index file has been added for design/, release/ & testing/. Change-Id: I536929924de42c855b6e775a1f2391db4cd04fc1 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-27New Tox build scriptShubhamRathi2-0/+16
To keep the doc jobs for OPNFV & ODL as similar as possible, we're using a similar tox build script as used in ODLDocs. The new merge job is tested to run the same tox build script. This build script is to be run as `tox -edocs`. Everything under docs/ shall be built. Change-Id: Ic4fab5e431e6937a1dbbeca2b1ff339dd092b688 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-26Removing RTD HackShubhamRathi2-8/+1
Eliminated rm -rf * from conf.py file & time, date of generation from index. Change-Id: I1c2c3da15a11b59659b9fbb46982bf71d7ec2ba9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-25Merge "RTD Workaround to delete old files"Aric Gardner2-53/+61
2017-01-24Merge "Adding all templates under templates/"Sofia Wallin13-0/+676
2017-01-24Merge "Original 'Including your Documentation'"Sofia Wallin1-0/+66
2017-01-24Original 'Including your Documentation'ShubhamRathi1-0/+66
Moving all content out of the wiki, plan is to keep document build instructions in the opnfvdocs repo too. This file shall be edited with the new instruction. Change-Id: Ie2e441be1810182c101bd3819ddc6587e1c6b2c2 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-23Updated intro and vsperf project description.Trevor Cooper1-22/+22
Updates: Fixed review issues with trailing white spaces, Bottlenecks description and made further vsperf description edits. Change-Id: Id1c979f6365b022f27ab79ac7b75a42110e0150b Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
2017-01-22Adding all templates under templates/ShubhamRathi13-0/+676
Templates for docs contribution have been added under templates/ .Templates for release/ have been added only. Most of these templates have been made by resuing the structure and content of previous releases to reduce rework on part of project teams. Change-Id: I13f9b7fbb372bd712ee64aed775a2cede771f429 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-20RTD Workaround to delete old filesShubhamRathi2-53/+61
Workaround to delete old files in RTD: We are callling a subprocess from conf.py file to rm -rf *.The builds on RTD are failing but documentation is being updated nonetheless, to check - we are seeing the build time and date in index. Change-Id: I278490e322e97e263d90f568fe4331bcc40ff4ad Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>