summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/documentation-guide.rst
AgeCommit message (Collapse)AuthorFilesLines
2018-11-06Fix minor Documentation Formatting ErrorsTrevor Bramwell1-1/+1
These include wrongly indented bullet points, title underlines, and malfomed links. Templates which are used for project documentation are also excluded from builds as they are orphaned pages. Change-Id: Iaabfb5f2bbf0b9bdfabec622e0b75dd23ea9e472 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2018-08-03Submodule to RTD transition documentationTrevor Bramwell1-1/+1
Adds documentation for current projects on how to migrate to using local doc builds, along with steps for new projects to setup their builds. Issue: DOCS-191 Change-Id: I1c850457dec1006199d095ad63469af1ca02a760 Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
2017-09-29Put initial structure for infra documentationFatih Degirmenci1-1/+3
Change-Id: I4d8ed269cbf0eeedaa0ee540ac2fd6bca5e429b0 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-08-27infra: Add proposal for including infra documentationFatih Degirmenci1-4/+11
This change proposes addition of infrastructure to OPNFV Documentation on RTD. Proposed sections are - software-infrastructure: proposal to move documentation for OPNFV software infrastructure such as Gerrit, Artifact Repository, Jenkins, and so on, from OPNFV Wiki [1] to RTD. - continuous-integration: proposal to move documentation for OPNFV Continuous Integration from OPNFV Wiki [2] to RTD. - cross-community-continuous-integration: proposal to move documentation for OPNFV XCI from OPNFV Wiki [3] to RTD. Proposal for including the documentation for hardware infrastructure is not included in this change as there is already documentation in different place on RTD. It will be clarified later. [1] https://wiki.opnfv.org/display/INF/Software+Infrastructure [2] https://wiki.opnfv.org/display/INF/Continuous+Integration [3] https://wiki.opnfv.org/pages/viewpage.action?pageId=8687635 Change-Id: I4f22d9f22135c70b55b5e92aa3338a4c3889bee1 Signed-off-by: Fatih Degirmenci <fatih.degirmenci@ericsson.com>
2017-05-18Updated license informationSofia Wallin1-18/+12
Added the SPDX license according to recommendation from LF. Change-Id: Ic0fbdde46d28ef6bfe8ccf975572403d0356e170 Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
2017-03-08Fixed warningsSofia Wallin1-26/+56
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-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 documentationShubhamRathi1-5/+0
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-08Documentation guide ported from wikiShubhamRathi1-0/+116
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>