16:10:40 <colindixon> #startmeeting docs
16:10:40 <odl_meetbot> Meeting started Wed Jan  6 16:10:40 2016 UTC.  The chair is colindixon. Information about MeetBot at http://ci.openstack.org/meetbot.html.
16:10:40 <odl_meetbot> Useful Commands: #action #agreed #help #info #idea #link #topic #startvote.
16:10:40 <odl_meetbot> The meeting name has been set to 'docs'
16:11:02 <colindixon> #topic overview docs
16:18:01 <colindixon> #info denise says that she's getting to a place where she's pretty happy with the overview document she's working and hopes to have it in a reasonable shape soon after many iterations trying to find the right narrative
16:19:18 <colindixon> #info denise asks about getting stuff into git from google docs, colindixon says that it should be easy 10s of minutes per document with formatting conversion, but not seconds or hours
16:22:22 <colindixon> #topic documentatin reviews
16:22:49 <colindixon> #link https://git.opendaylight.org/gerrit/#/q/project:docs+status:open+NOT+label:Code-Review%253C0 still have >25 outstanding docs patches that need to be reviewed
16:23:09 <colindixon> #topic toolchains
16:23:38 <colindixon> #info phrobb_ assk about what it will take to get decent HTML docs from asciidoc
16:26:14 <colindixon> #info colindixon says it should be doable because we use the same toolchain as openstack and they produce good-looking HTML
16:27:35 <colindixon> #info colindixon thinks there are likey to be three things to get past that (1) figure out how we're using the toolchain differentely from OpenStack and then inside that, (2) figure out themeing and (3) figure out how to avoid sections being split up
16:29:39 <colindixon> #info (3) is likely to be the most annoying and might involve refactoring of our actual asciidoc (but colindixon hopes not) instead of just chaning tool configuration
16:30:54 <colindixon> #Info phrobb_ asks about getting API doc stuff published and how
16:32:05 <colindixon> #info colindixon says he thinks we publish a WADL to generate our MD-SAL APIdoc explorer and we ought to be able to coopt that to produce stuff as part of build along with javadoc and publish to maven sites
16:32:18 <colindixon> #info colindixon suggests talking to zxiiro about this
16:33:13 * zxiiro is here
16:33:40 <colindixon> phrobb_ will reach out to you about it I'm pretty sure
16:36:06 <colindixon> https://wadl.java.net/
16:40:43 <colindixon> http://localhost:8181/apidoc/explorer/index.html
16:42:29 <anipbu> https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=tree;f=opendaylight/restconf/sal-rest-docgen
16:42:43 <colindixon> #link http://localhost:8181/apidoc/explorer/index.html if you go here, you get the API doc explorer for our running controller, but it would be good to have that also hosted in nexus
16:43:10 <colindixon> #info phrobb_ asks if anyone doing stuff other than YANG => WADL for MD-SAL-hosted APIs
16:43:24 <colindixon> #info colindixon says no, but we could probably get there pretty quickly since WADL is a pretty common standard
16:48:55 <phrobb_> Here is an interesting page: https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer
16:49:39 <anipbu> #link https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/src/main/features/features.xml;
16:53:13 <anipbu> in the lithium world, it was located here: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=tree;f=opendaylight/md-sal/sal-rest-docgen;h=162c17083dc36b8328580114276de759c3b26ab9;
16:55:12 <colindixon> https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer
16:56:58 <colindixon> #info long discussion on where the current apidoc lives (turns out it's sal-rest-docgen that was in controller/mdsal and is now in netconf)
17:00:22 <zxiiro> https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/
17:00:32 <colindixon> #link https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer this seems to be the most current documentation and it goes to swagger (not WADL as colindixon said earlier)
17:02:44 <colindixon> #info colindixon and phrobb_ ask about generating javadoc for everyone, zxiiro says we need maven sites to get that right and to get maven sites to work right involves editing every single pom file in ODL to get the URL right (either by specifiying a non-standard URL or by following proper directory/groupId organization)
17:04:50 <zxiiro> https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/dependency-convergence.html
17:05:31 <colindixon> #link https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/dependency-convergence.html this tracks version skew automatically as part of maven sites
17:08:27 <colindixon> #info around the apidoc exploer, it looks like ryan goulding, robert varga, and tom pantelis are the currently active people who have maintained it
17:10:10 <colindixon> #endmeeting