summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
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>
2017-01-12Update build script to newer tagShubhamRathi1-1/+1
The build script showed the tag as 'arno.2015.2.0'. The script has been updated to take the latest tag. Change-Id: Ifb64128d3c1097ac99130f00313d9eab7e885778 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2017-01-11Add submodules and .gitmoduleShubhamRathi46-2/+174
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>
2017-01-10Merge "Requirement updated to support sphinx_bootstrap_theme"Sofia Wallin1-0/+1
2017-01-09Requirement updated to support sphinx_bootstrap_themeShubhamRathi1-0/+1
Builds for the new conf.py's importing sphinx_bootstrap_theme (SBT) were failing because jenkins was still loading the previous version of requirements which did not have SBT. Adding the SBT to requirements will ensure the build does not fail. Change-Id: I9a46f519f5d5548e3a304a7d55d99e80a4366460 Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
2016-12-28Fixing a typoGerald Kunzmann1-1/+1
Change-Id: I6ee6f4133bab226a7a67b6e09a5c4cccd906ed6a Signed-off-by: Gerald Kunzmann <kunzmann@docomolab-euro.com>
2016-12-13Fix syntax errorYujun Zhang1-1/+1
Reported in https://gerrit.opnfv.org/gerrit/#/c/25785/ Change-Id: Iaba37b820ec17d8ac9009e63f606c8a38aebd236 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
2016-12-01Exit script with error countYujun Zhang1-4/+14
related JIRA: DOCS-71 Change-Id: I08501e6193dc555ebbb7b4b69af65e50ef4be5b7 Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
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-11-15Merge "Add support for macOS"Ryota Mibu1-9/+21
2016-11-08Merge "Colorado 2.0 updates"Sofia Wallin4-127/+124
2016-10-28Add support for macOSYujun Zhang1-9/+21
JIRA: DOCS-164 Change-Id: I769eb1d0fce7ead1ffb7c0a21e3aab969eeca3af Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
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-10-20Removal of Victor Laza from the list of comittersSofia Wallin1-1/+0
Removing Victor from the list of committers due to no activity. I have reached out several times without response. Change-Id: Ib86d3e8dfd44751fe7d0d9c4a4d71acd0eca6b8b Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2016-10-18Merge "Updated info file"Sofia Wallin1-1/+1
2016-10-18Updated info fileSofia Wallin1-1/+1
Updated contact info for Wenjing Change-Id: Id2456fc55765f02317c7c258bb84df07876a507a 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>