summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
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-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>
2017-01-20Move Scenario under releaseShubhamRathi3-0/+0
Scenario templates moved under Release. Spelling for Integration corrected. Change-Id: I3016ad8226293f3c806563b747fb14a140afece1 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-19Update testing community docMorgan Richomme5-40/+339
Change-Id: I7ffbb3c0460958e3ecd837a14bf0c9a5752d1fc0 Signed-off-by: Morgan Richomme <morgan.richomme@orange.com>
2017-01-16Adjusted naming pathSofia Wallin26-0/+0
Adjusted the naming path for consistency throughout our repository and the community. Change-Id: Ia055c418584f338f6000835fc28a7e5e8b5c5818 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-01-15Merge "Update build script to newer tag"Sofia Wallin1-1/+1
2017-01-15Add Index page for Feature ProjectsShubhamRathi1-0/+156
This feature index page lists all feature projects. This is proposed to be added under 'Developer Documentation' Change-Id: I84f21000923d3b00c93cb8b2b4d00c15711d19e9 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-15Add index page for subrelease projectsShubhamRathi1-0/+34
Index page for subrelease projects. This is proposed to be added under 'Release documentation' Change-Id: I66d9b5977697a1512ee3491921652dbad589bd23 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
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>