summaryrefslogtreecommitdiffstats
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 .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>
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-15Merge "A compact version of the documentation library."ChristopherPrice1-0/+157
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-14Removing the multipage HTML document and renaming the single page rendering.ChristopherPrice1-4/+2
This should be the final version for Colorado. We need to ensure people stop using the "-single" url's prior to release. Change-Id: Ib84c82582339f0de948d7b074d156343c566d535 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-05Removing excess License info.ChristopherPrice2-3/+3
Removed License info from the sidebar, on review it is not necessary. Change-Id: I12c7a4d4c6ec7498462e99e953867ba64630858b Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
2016-09-01Adding creative commons license info.ChristopherPrice3-3/+2
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 Wallin2-107/+8
2016-08-21Merge "add version, builddate and copyright in sidebar"Ryota MIBU2-0/+4
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-12Merge "Creating a template for feature projects to produce userguide and ↵ChristopherPrice4-0/+90
scenario description documents"
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-11add version, builddate and copyright in sidebarRyota MIBU2-0/+4
Change-Id: I652de718ebc1084230499eb7bc19e2fd9ab90159 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11fix workaround for doc8 errorRyota MIBU1-1/+2
Change-Id: I7c31f042f5fb02d1294e4a72aef872f153c55755 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-12Merge "remove 'Save to PDF' link from normal HTML pages"Ryota MIBU1-1/+3
2016-08-11workaround for doc8 error in python2.6Ryota MIBU1-1/+7
Change-Id: I9b8967e564b522354f6fdcea51fe493c9682d36f Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11remove 'Save to PDF' link from normal HTML pagesRyota MIBU1-1/+3
'Save to PDF' should be appeared in single HTML pages. JIRA: DOCS-156 Change-Id: I4566a976a8590a521bff4d0038597421f367f8e3 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-11remove pfd/odt creationRyota MIBU2-107/+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-11add 'Save to PDF' link in sidebarRyota MIBU2-0/+25
Change-Id: Ia9ffd10aa73c9e39203f31a5a19329006b68a444 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-10use doc8 in virtualenvRyota MIBU2-4/+5
Change-Id: I58fd9e9382932ebc2521765bb665dcf0473d6a68 JIRA: DOCS-152 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-08-10add creation of singlehtml for downloadable docsRyota MIBU1-0/+12
Change-Id: I4e7b188f43d69866fa5f42b4393e92f91cd795a2 JIRA: DOCS-156 Co-Authored-By: Aric Gardner <agardner@linuxfoundation.org> Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-27Merge "Updating the scenario installation template based on comments."ChristopherPrice5-695/+33
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-25remove build-composite.shRyota MIBU1-11/+0
The contents in build-composite.sh were already moved to docs/pre-hook.sh . After jjb was updated to use scripts/docs-build.sh instead of build-composite.sh , we can remove it. Change-Id: Icbffed34a281a9119dca57d26a003fd2f0791731 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
2016-07-25fix pre-hookRyota MIBU2-2/+9
- 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 MIBU3-115/+127
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>