17:04:32 <Madhu> #startmeeting TWS
17:04:32 <odl_meetbot> Meeting started Mon Sep 15 17:04:32 2014 UTC.  The chair is Madhu. Information about MeetBot at http://ci.openstack.org/meetbot.html.
17:04:32 <odl_meetbot> Useful Commands: #action #agreed #help #info #idea #link #topic #startvote.
17:04:32 <odl_meetbot> The meeting name has been set to 'tws'
17:04:51 <Madhu> #chair tbachman colindixon phrobb networkstatic
17:04:51 <odl_meetbot> Current chairs: Madhu colindixon networkstatic phrobb tbachman
17:04:52 * colindixon wanders in
17:04:57 * tbachman is here
17:05:31 <tbachman> #topic documentation
17:05:31 <Madhu> #topic Documentation process for Helium
17:05:38 <tbachman> :)
17:05:49 <colindixon> #undo
17:05:49 <odl_meetbot> Removing item from minutes: <MeetBot.ircmeeting.items.Topic object at 0x2534210>
17:05:51 <colindixon> #undo
17:05:51 <odl_meetbot> Removing item from minutes: <MeetBot.ircmeeting.items.Topic object at 0x2534250>
17:05:56 <colindixon> #topic Documentation process for Helium
17:06:05 <Madhu> #info regXboi taking the lead on documentation process
17:06:18 <phrobb> is webex failing for anyone else or am I just *special*
17:06:25 <tbachman> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Docs_and_Structure link for docs for Helium
17:06:44 <tbachman> phrobb: failling?
17:06:50 <Madhu> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group Documentation group page
17:07:13 <Madhu> #info documentation has its own repo and every Helium participating project needs to update their documentation on this project
17:07:16 <phrobb> connection just sits and spins
17:07:24 <tbachman> phrobb: that sometimes happens :(
17:07:49 <tbachman> phrobb: this is the link I used, fwiw: https://meetings.webex.com/collabs/meetings/join?uuid=M749G9M6E4A5JG72SD48WWG57F-9VIB
17:07:51 <Madhu> phrobb: firefox & webex don't work great.
17:08:23 <Madhu> tbachman: colindixon can u pls info it in for a few guys ? brb
17:08:25 <phrobb> this is chrome failing… will need to reboot more of my box and keep trying… be there soon...
17:08:37 <colindixon> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:How_To the how to page regXboi is going through
17:08:43 <Madhu> tx colindixon
17:09:03 <tbachman> #info once you have documentation you want to add, use the decision matrix on that wiki page to determine where that documentation goes
17:09:14 <colindixon> #info the docs project is for documentation that is angled to people both in the ODL community and outside the ODL community
17:09:43 <colindixon> #Info there is a giant flow chart that shows how to decide what kind of documentation you need to create
17:10:12 <colindixon> #info there is a docs channel: #opendaylight-docs where you can go ask for help
17:11:07 <tbachman> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Tools tools for documentation
17:11:20 <tbachman> #info you can build documentation in linux, but not in windows
17:12:24 <colindixon> #topic demo
17:12:48 <colindixon> #undo
17:12:48 <odl_meetbot> Removing item from minutes: <MeetBot.ircmeeting.items.Topic object at 0x2580190>
17:13:50 <tbachman> (sound of dueling banjos)
17:14:04 <colindixon> #info you should be able to find your project as a .adoc projet somewhere in the docs project
17:14:31 <colindixon> #info it may be in multiple places, this should be your own chapter (or section or file)
17:16:23 <colindixon> #info you may need to add it in other places: regXboi shows that there is a controller.adoc in the developers-guide, operations-guide and user-guide (should probably also be in the installation guide)
17:16:33 <tbachman> #info raghu67 asks how we plan to deliver the docs when the distribution is downloaded?  Are they delivered separately
17:17:08 <tbachman> #info regXboi says there will be site deploy job to a maven site to make them available online
17:18:19 <colindixon> #Info these .adoc files are linked into the “books” which are called bk-*.adoc, e.g., bk-user-guide.adoc (you can find them with something like “find . -name bk*.adoc”)
17:19:26 <colindixon> #info regXboi says that for Helium (unlike in Hydrogen), docs will be forked onto a stable helium brnach that will (forever and always) have helium docs while master will then move on to Lithium and so on
17:20:04 <tbachman> #info networkstatic asks if any of the projects had already done the work and could be used as a reference
17:20:26 <tbachman> #info colindixon says that the l2switch project has documentation that looks good, but that may be on a private repo
17:21:11 <tbachman> #info regXboi says that the “door is open” for projects to start submitting their documentation, so they can be used as a reference
17:22:06 <tbachman> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:How_To wiki page explaining to projects how to generate and deploy documentation
17:23:05 <tbachman> #info regXboi recommends going through step 5 lots of times, as there are lots of interesting side-effects (i.e. review what it generates, and make sure it looks like you want it to)
17:23:08 <colindixon> #info regXboi notes that step 5 “build/review/edit test documentation by following these steps” is importa, for example you *must* leave a blank line at the end of every chapter of things will go wonky
17:23:21 <tbachman> colindixon: that’s a better one ;)
17:23:45 * tbachman looks for wikipedia entry on “wonky"
17:23:45 <colindixon> #topic demo
17:24:34 <colindixon> #info regXboi edits the controller.adoc file in the developer’s guide to add a few words
17:26:00 <colindixon> #info regXboi notes that if you do “mvn install” it will likely not re-generate the pdfs, make sure to have clean in there, e.g., “mvn clean install"
17:28:01 <tbachman> #info once you’ve made all your changes, push your changes to gerrit
17:28:24 <tbachman> #info the documentation committers may come back and talk to you about your commit
17:28:53 <colindixon> #info shows opening target/docbkx/webhelp/bk-developers-guide/bk-developers-guide-20140915.pdf (now has the controller text in it)
17:30:06 <colindixon> #topic high-level steps
17:30:50 <colindixon> #info 1.) go to the documentaiton how to page and go through the flow chart
17:31:07 <colindixon> #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:How_To the documentation how to page
17:31:59 <colindixon> #info 2.) the flow chart will tell you what kind of docs you should create
17:32:25 <colindixon> #info 3.) each kind of docs, e.g., user guide, developer guide, has a folder in the docs git repo
17:33:09 <colindixon> #info 4.) in each of those folders there should be a .adoc file for your project, if not, reach out and/or just create it for yourself
17:33:35 <colindixon> #info 5.) add your stuff and test building it to make sure it looks right, then push it for review just like any other code
17:38:58 <colindixon> #topic more questions
17:39:06 <colindixon> #info networkstatic asks if we should focus on the wiki or asciidoc
17:40:12 <colindixon> #info regXboi and colindixon say that they think focusing on the asciidoc makes more sense, but they aren’t part of the docs project
17:40:53 <colindixon> #info colindixon in particular notes that the effort might be less: to get the wiki docs up you need to find the good and elminate the bad, to get the asciidocs working just involves finding the good and copying it into the asciidoc
17:45:01 <colindixon> #info networkstatic asks if the set of docs that gets in that losk good could be sent out to a braoder audience as a good example
17:45:21 <colindixon> #topic hardcore pleading for people to test their features in RCs
17:45:23 <networkstatic> ty sir
17:47:02 <tbachman> #info colindixon urges projects to test and use their code as their users would, in order to make sure that everything is working
17:47:31 <colindixon> #info colindixon gets down on his hands an knees and pleads for for people to actually download RCs either the weeklies or the nightlies and test it
17:48:06 <phrobb> Is it this one: https://docs.google.com/spreadsheets/d/1PYxjiSYEks44uJByVO1P44rnI5xTJRulpKyrSsDQF9g/edit#gid=528993842
17:48:13 <colindixon> #info colindixon says not just running mvn clean install, but actually bring the distribution up, bring up the features you want to test (and the ones you think people will want to run with your stuff) and then make sure what you want your users to do works
17:48:51 <colindixon> #info do this *at least* once a week, and preferably more often
17:50:00 <colindixon> #topic remaining things
17:50:17 <colindixon> #info what we *need* need to do is test, Test, TEST and doc, Doc, DOC now
17:50:26 <tbachman> lol
17:50:37 * tbachman laughs ([for|at]) networkstatic
17:50:46 <colindixon> #info CASP3R says please, reach out to integration if you need help with tests, etc.
17:50:49 <tbachman> jk
17:51:56 <tbachman> #endmeeting