Hi Sofia, One question regarding the submodules: how do you manage the versioning of the submodules? Do we need to manually bump the version of the respective project submodule after submitting new documentation to our project repo or will your Jenkins job automatically bump the version?
Thanks, Georg From: opnfv-project-leads-boun...@lists.opnfv.org [mailto:opnfv-project-leads-boun...@lists.opnfv.org] On Behalf Of Sofia Wallin Sent: Wednesday, February 22, 2017 11:26 AM To: TECH-DISCUSS OPNFV (opnfv-tech-discuss@lists.opnfv.org) <opnfv-tech-discuss@lists.opnfv.org>; opnfv-project-le...@lists.opnfv.org Subject: [opnfv-project-leads] [opnfvdocs] [opnfv-tech-discuss] Update - Migration to readthedocs Hello, As many of you already know, as part of the Danube release we are migrating all our documentation to readthedocs, an online documentation service. There are a few changes with respect to documentation that everyone should be aware of: Distinct release, development and testing documentation As part of the D release, the docs projects is working towards organizing the documentation under three distinct banners: release, development and testing, as also seen on docs.opnfv.org<http://docs.opnfv.org> [1] We have put together a documentation guide [2] which will help project teams understand the changes expected in each project repo. NOTE: Discussions regarding structure of the page and naming was brought up yesterday and are ongoing. Simplified documentation toolchain The move to readthedocs has greatly simplified our documentation toolchain. The docs project has incorporated each project as a submodule in its repo. Whenever content is merged in <project>/docs/, the documentation toolchain shall automatically trigger building of the new documentation on readthedocs (allow around 15 minutes for the documentation to show after merging). The new doc jobs are docs-verify-rtd-{stream} & docs-merge-rtd-{stream}. Detailed instructions on how to include documentation, validate markup and test build (locally) have been mentioned in the 'Include Documentation' [3] We shall gradually be phasing out the artifacts.opnfv.org<http://artifacts.opnfv.org> as part of the migration to readthedocs. Project teams are requested to adapt to the new tool chain. Please let us know if you have questions. Regards, OPNFVDOCS Team [1] http://docs.opnfv.org/en/latest/ [2] http://docs.opnfv.org/en/latest/how-to-use-docs/documentation-guide.html [3] http://docs.opnfv.org/en/latest/how-to-use-docs/include-documentation.html
_______________________________________________ opnfv-tech-discuss mailing list opnfv-tech-discuss@lists.opnfv.org https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
