Hi Sofia, all,
The current content of the userguide.introduction.rst doesn't at all look like
the example in
http://docs.opnfv.org/en/latest/how-to-use-docs/include-documentation.html#include-documentation
vim opnfvdocs/docs/release/userguide.introduction.rst
This opens the text editor. Identify where you want to add the userguide. If
the userguide is to be added to the toctree, simply include the path to it,
example:
.. toctree::
:maxdepth: 1
submodules/functest/docs/userguide/index
submodules/bottlenecks/docs/userguide/index
submodules/yardstick/docs/userguide/index
<submodules/path-to-your-file>
Will opnfvdocs team do the first version of this file according to the
instructions? Or should individual projects start adding submodules for their
project?
Best regards,
Gerald
From: [email protected]
[mailto:[email protected]] On Behalf Of Sofia Wallin
Sent: Mittwoch, 22. Februar 2017 11:26
To: TECH-DISCUSS OPNFV ([email protected])
<[email protected]>; [email protected]
Subject: [opnfv-tech-discuss] [opnfvdocs] [opnfv-project-leads] 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
[email protected]
https://lists.opnfv.org/mailman/listinfo/opnfv-tech-discuss
