Fyi. ---------- Forwarded message ---------- From: Colin Dixon <[email protected]> Date: Thu, Aug 11, 2016 at 8:08 AM Subject: [release] migration of user/developer guide to reST in boron To: "[email protected]" <[email protected]>, ODL Docs <[email protected]>
tl;dr The documentation team is planning to automatically migrate projects' documentation from AsciiDoc to reStructuredText. Expect a patch for you to review sometime in the next week or so. If you'd like to see it sooner and/or opt-out, let us know. full version === As part of our work in Boron, the documentation team has been working on how to migrate our documentation from AsciiDoc/AsciiDoctor/maven sites to reStructuredText/Sphinx/read the docs. The most tangible results of our efforts is this: http://docs.opendaylight.org/ There's information about the migration here: http://docs.opendaylight.org/en/latest/documentation.html https://wiki.opendaylight.org/view/Documentation/Tools/reStructuredText We did a TWS on the migration on Monday. You can find the WebEx recording under the August 8th, 2016 meeting here: https://wiki.opendaylight.org/view/Tech_Work_Stream:Main# Information_From_Past_Meetings The biggest take-away we showed was that we can do automatic migration from the current AsciiDoc to reStructuredText using a combination of our current build tools, pandoc and a script from Xinghao (the documentation intern). The script is here: https://github.com/opendaylight/docs/blob/master/makeRST.sh Our plan is to create one patch per project that migrates the existing documentation to reST and replaces the AsciiDoc with a pointer to the appropriate URL to see the new reST-based hosted HTML documentation. For patches under-review, we will either convert them or hold-off converting the existing documentation until they've been merged. If you'd like to see it sooner and/or opt-out, let us know. Cheers, --Colin _______________________________________________ release mailing list [email protected] https://lists.opendaylight.org/mailman/listinfo/release
_______________________________________________ openflowplugin-dev mailing list [email protected] https://lists.opendaylight.org/mailman/listinfo/openflowplugin-dev
