Notes

[14:18] <colindixon> #info 1.) we need is a jenkins job that builds the docs project using sphinx and fails the build on errors
[14:18] <colindixon> #info zxiiro says we might already have this for spectrometer and could just reuse it
[14:19] <colindixon> #info zxiiro says that what we really have a tox build job that should be able to run sphinx and that would do it and hopefully fail things as long as we have a sane tox file
[14:19] <colindixon> #info we would use that as a verify job for docs (and possibly all other projects)
[14:19] <colindixon> #info 2.) we need to (possibly with project help) convert all of our AsciiDoc to ReStructuredText
[14:20] <colindixon> #info it's likely that a script would help with most of this, are there conversion tools?
[14:20] <colindixon> #info 3.) as a stretch goal, allow projects to host their own docs, but make sure they can't break the world
[14:20] <colindixon> #info that means they have their own docs-verify job for their local project
[14:21] <colindixon> #info also they should probably run the whole docs job later to catch key things
[14:21] <colindixon> #info zxiiro says if buidling all the docs doesn't take very long, we could just use the docs project verify job to run on all patches
[14:22] <colindixon> #info zxiiro notes that we could only trigger builds that change the docs directory within projects
[14:22] <colindixon> #info 4.) possilby cutomizing our readthedocs page with a better theme, etc.
[14:22] <colindixon> #info 5.) seeing if there are tools to pull code snippets from live code in git repos
[14:25] <colindixon> #info 6.) seeing if readthedocs can generate PDFs at a smaller granularity than all of the docs, at least for the project-level that should be doable using what we're doing, with more Makefiles
[14:28] <colindixon> #topic questions
[14:28] == odl_meetbot changed the topic of #opendaylight-docs to: questions (Meeting topic: docs)
[14:29] <colindixon> #info beau asks what exactly is happening, colindixon says we're moving from asciidoctor/maven/asciidoc to readthedocs/sphinx/restructuredtext
[14:29] <colindixon> #info Xinghao_ asks if we want it to be trigger by maven
[14:30] <colindixon> #info zxiiro says probably not since maven takes forever to load to only call a python script
[14:31] <colindixon> #info colindixon says that's true, but it might be nice if we called that when we called mvn clean install, zxiiro says maybe not since it will fail if you don't have tox installed
[14:32] <colindixon> #info colindixon says that the only bad thing there is that what will happen is that people will push a patch, verify will fail because of misformatted docs, and they won't be able to figure out how to reproduce it locally
[14:32] <colindixon> #info 7.) lots of documentation about how the docs toolchain works, including messages in the docs verify job fails to give instructions
[14:34] <colindixon> #Info 8.) figure out tooling around release notes that would help