summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2017-03-23Update git submodulesTrevor Cooper1-0/+0
* Update docs/submodules/vswitchperf from branch 'stable/danube' - Updates release note numbering Change-Id: Id0510b96375033540fa80fe22b301fb1d0d20e40 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit bc150a3ea5ac7729747e16bb093c37101e2b803c) - Updated results and sceanrios for Danube Change-Id: I3f29b4e9431a98d65f363273bed57f96d6e993ca Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Updates for new doc structure Change-Id: Idc496e246f966f2882ce0c439913c9379b31c5ea Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - New doc structure changes for stable/danube Change-Id: I2e9b432a74ee22690fdb366de619dc3a5d2ad725 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Moved results to developer dir Change-Id: I7d2d5939e018c7abae03663b13be8f8f038256c0 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Moved requirements to developer dir Change-Id: I2fa9e32d4ae92aa1f075c1da8e2acb3912f3f7bc Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Moved design to developer dir Change-Id: I487619deca2658d5239cccd41098751cc8245b34 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Moved userguide to user directory Change-Id: I35f2cbbab8ce7daec26fed63fa92cf7c17cd37b3 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Moved configguide to user dir Change-Id: I13b6b2cb184d864f41ecfe9478c02bfc8257fff3 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Updated release notes index file Change-Id: I68e1eb9313ebca753f31094137d7d50a24e33c69 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> - Renamed release notes file and added index file to release-notes dir Change-Id: I448fd909a89103b2c11cb16f91b8c646fb5adee8 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com> (cherry picked from commit 59668b1aa68da507335ef351619d9f50019df762) - Fix fuel plugin installation issue in latest ISO Change-Id: I8383b469f5350f4457cf234de2a4ff8f79151afe Signed-off-by: Guo Ruijing <ruijing.guo@intel.com>
2017-03-22Update Feature ProjectsShubhamRathi1-49/+102
Populated feature projects page. Change-Id: Ie8112c609d3bfef4c5971b296ddbc6fb341283cf Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit 79c76dbaf754da47e186d5743970bc863e14fb74)
2017-03-22Add git submodule for openretrieverGuo Ruijing1-1/+5
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> (cherry picked from commit 2c15655630684cf466351507de1a266b4abb9b50)
2017-03-22qtip: correct project name letter caseYujun Zhang3-4/+4
As a project name, uppercase i.e. QTIP is preferred Change-Id: Id19e50f9f593c1eb0afbf6604bca3314f6223587 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn> (cherry picked from commit 09ca5781daa03385fc8a5c964d38512124a64dbc)
2017-03-22Segregating Testing docShubhamRathi3-5/+80
Testing documentation has been segregated under 'User Guides' & 'Developer Guides' as decided by the test teams. Change-Id: I04a11ff88b329f4daad2ef020aefd0779d5a7ca5 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit ccb6ee17f999c09e785083c4c9e418f21ffbdef0)
2017-03-22Fix multisite linksShubhamRathi2-18/+18
Multisites links would now show up in the documentation. Its latest commits have been synced. Change-Id: Iafd4d5fbe572bfd4abb12a306363868a9015d75e Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit e6998f5052fdf5d2505f411c67363ef40d7a14b8)
2017-03-22Misc ChangesShubhamRathi4-11/+8
1. Renamed ‘How to work with Documentation’ to Documentation Guide 2. Add Test Overview documentation breneath ‘Testing’ 3. Removed the index off Release Notes Change-Id: Iaef364f5ee59a99f906270271c1daf49cfae4c4f Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit 7cc71e8d705f20d4a36f9bcd9e022e439cf31197)
2017-03-22Adding opera submoduleAric Gardner1-0/+0
This will fix build: https://gerrit.opnfv.org/gerrit/#/c/29335/5 Change-Id: Ib2e214374ab071a11a46588b83113b43468ebdb1 Signed-off-by: Aric Gardner <agardner@linuxfoundation.org> (cherry picked from commit 7d76bf377d21d4f3d9946078482e23e87f707cca)
2017-03-21Remove nonparticipating projectsShubhamRathi9-0/+0
Removed projects not part of Danube to save build time. Change-Id: I9557d17a2ba7b6af963fd178d760f8df09ffe12d Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit c033d4b702018ec6a00492f20f26049b66a3da94)
2017-03-21Merge "CSS Changes to layout" into stable/danubeSofia Wallin3-1/+26
2017-03-21Removed openretriever off submodulesShubhamRathi1-0/+0
Change-Id: Iea4f3f579e837bc4ff199a65b717be28113de2ef Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit 86879954e4c2636c5cf71d3539a1b2a356e66b68)
2017-03-21CSS Changes to layoutShubhamRathi3-1/+26
1. Logo has been scaled up 2. Font has been defaulted to 'Arial' Change-Id: I7d729009649ba59394f5a78c6909b6af21bae0ab Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit 6e4ba246bfa93f285cabd242d392dccfbaee03ce)
2017-03-20Update submodulesShubhamRathi2-0/+0
Update HEAD of Barometer & Multisite so that gerrit auto syncs the submod- ules Change-Id: I38cd7b4330f3408020d5e2fdba132b6fe95641ce Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit d97329d77fbc5f9ac6077b907b266b8fd5303009)
2017-03-20Updating 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> (cherry picked from commit 1fc4463cbdaad35db04cc81fa6575ca721920785)
2017-03-20Using SPDX shorthand plus a several edits for wordsmithingRay Paik2-30/+31
Change-Id: I1c04abf0d22c49239636ea50ef62e7fd88a03743 Signed-off-by: Ray Paik <rpaik@linuxfoundation.org> (cherry picked from commit c03471c38dd57052ca78e85c9ada9b6bdc1cfc19)
2017-03-20Add SidebarShubhamRathi2-0/+4
Change-Id: I1425eda919f49cbc82d1ab60ef91324d9afee041 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com> (cherry picked from commit 43b90b762d5df17fac7395a709b5262b51c04375)
2017-03-20Updated license header with SPDXSofia Wallin1-1/+1
Change-Id: I7fa081f2e3c01f053388ae8f85983abb007ab7f7 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit 330aafa18db7133b1e3c08f80c874b0136b1cb4c)
2017-03-20Add 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> (cherry picked from commit 1aabf0aab713a4b4e08a773b1701d0fbb1c74ece)
2017-03-20Misc 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> (cherry picked from commit 77a324e8f19bb42d08116a895d2c31fac2e608f9)
2017-03-16updated the license header to use the SPDX shorthandRay Paik1-6/+6
Change-Id: I0f4e81bafbfdfdb6909a283907a5baa497552622 Signed-off-by: Ray Paik <rpaik@linuxfoundation.org> (cherry picked from commit e025c0337b0483ff608347d43caa1b0414d97be2)
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-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-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 changesShubhamRathi6-6/+7
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-20Merge "Add Promise release docs to opnfvdocs"Sofia Wallin1-2/+2
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 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-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>