#opendaylight-docs: docs

Meeting started by colindixon at 16:10:40 UTC (full logs).

Meeting summary

  1. overview docs (colindixon, 16:11:02)
    1. 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 (colindixon, 16:18:01)
    2. 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 (colindixon, 16:19:18)

  2. documentatin reviews (colindixon, 16:22:22)
    1. 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 (colindixon, 16:22:49)

  3. toolchains (colindixon, 16:23:09)
    1. phrobb_ assk about what it will take to get decent HTML docs from asciidoc (colindixon, 16:23:38)
    2. colindixon says it should be doable because we use the same toolchain as openstack and they produce good-looking HTML (colindixon, 16:26:14)
    3. 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 (colindixon, 16:27:35)
    4. (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 (colindixon, 16:29:39)
    5. phrobb_ asks about getting API doc stuff published and how (colindixon, 16:30:54)
    6. 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 (colindixon, 16:32:05)
    7. colindixon suggests talking to zxiiro about this (colindixon, 16:32:18)
    8. https://wadl.java.net/ (colindixon, 16:36:06)
    9. http://localhost:8181/apidoc/explorer/index.html (colindixon, 16:40:43)
    10. https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=tree;f=opendaylight/restconf/sal-rest-docgen (anipbu, 16:42:29)
    11. 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 (colindixon, 16:42:43)
    12. phrobb_ asks if anyone doing stuff other than YANG => WADL for MD-SAL-hosted APIs (colindixon, 16:43:10)
    13. colindixon says no, but we could probably get there pretty quickly since WADL is a pretty common standard (colindixon, 16:43:24)
    14. https://git.opendaylight.org/gerrit/gitweb?p=netconf.git;a=blob;f=features/restconf/src/main/features/features.xml; (anipbu, 16:49:39)
    15. https://wiki.opendaylight.org/view/OpenDaylight_Controller:MD-SAL:Restconf_API_Explorer (colindixon, 16:55:12)
    16. 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) (colindixon, 16:56:58)
    17. https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/ (zxiiro, 17:00:22)
    18. 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) (colindixon, 17:00:32)
    19. 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) (colindixon, 17:02:44)
    20. https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/dependency-convergence.html (zxiiro, 17:04:50)
    21. https://nexus.opendaylight.org/content/sites/site/org.opendaylight.odlparent/beryllium/dependency-convergence.html this tracks version skew automatically as part of maven sites (colindixon, 17:05:31)
    22. around the apidoc exploer, it looks like ryan goulding, robert varga, and tom pantelis are the currently active people who have maintained it (colindixon, 17:08:27)


Meeting ended at 17:10:10 UTC (full logs).

Action items

  1. (none)


People present (lines said)

  1. colindixon (27)
  2. odl_meetbot (3)
  3. anipbu (3)
  4. zxiiro (3)
  5. phrobb_ (1)


Generated by MeetBot 0.1.4.