00:01:13 #startmeeting 00:01:13 Meeting started Wed Apr 9 00:01:13 2014 UTC. The chair is paulz. Information about MeetBot at http://wiki.debian.org/MeetBot. 00:01:13 Useful Commands: #action #agreed #help #info #idea #link #topic. 00:01:41 Do you have "updates" in the agenda? 00:02:15 Here's what I have on the agenda... some updates sound great! 00:02:21 #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group 00:02:27 Colin here 00:02:31 Hi Colin 00:02:47 Hello Paul 00:02:49 Hi Colin 00:02:58 #topic Intros for any new folks 00:03:02 Kent here, but poping in and out 00:03:32 Hi Kent, thanks for joining us! 00:03:33 Hi I'm Mathieu Lemay (Inocybe Technologies) 00:03:44 nice to meet you 00:04:18 Paul Zimmerman (Cisco) here 00:05:13 Other folks can chime in when they can, I'll move to the next topic 00:05:19 ok 00:05:24 #topic Actions from last time 00:05:34 I had an action: Paul to talk with Ed & Phil about the server for hosting the docs 00:06:08 I got Andrew G's name and added Mathieu to the message as he knows best what's going on with the tooling 00:07:03 Mathieu, Andrew had some specifics about how he thought the server should be set up. Any issues there? 00:08:10 I don't know if it's going to work 00:08:15 but I'll try it first 00:08:21 I need to give it a shot 00:08:23 and see 00:08:43 For everyone else, here's what Andrew wanted 00:08:44 Andrew wanted a format that would work with a maven site-deploy. It's easier for him to put up a special "docs" repo for our project to push into that way and then he can just configure a front end proxy to deal with rewriting requests for docs.opendaylight.org to the nexus backend 00:09:12 on that I think we could recommend / assist projects publishing their API + JAvasoc 00:09:16 *Javadoc 00:09:24 have a standardized template of some sort 00:09:53 I know Ryan (regXboi) from OpenDOVE actually worked on site deploy versioning 00:10:11 That's definitely an imporant part of the doc set, so that would be good. 00:10:35 There are more parts, though... the programmer's guides and config, etc... that seems more challenging for versioning. 00:11:02 (wonderful.. http://www.rackspace.com/sitemap404.php?url=/writers-guide/content/ch_preface.html%20site:docs.rackspace.com) is now 404 (was the plugin docs) 00:11:26 correct 00:13:11 So Mathieu, can I give you an action to see if Andrew's requirements meet our workflow requirements? 00:14:34 yes 00:14:35 sure 00:14:44 I'll give it a shot with Andrew 00:15:14 #action Mathieu to verify Andrew's server requirements work with ODL doc toolchain 00:15:20 Cool! Thanks. 00:15:34 hi nan 00:15:39 The other action was completed, I think... akim to sync with mlemay on mvn install issue 00:15:40 hi guys 00:15:50 Hi! 00:15:52 sorry being late 00:16:06 pls continue 00:16:11 paulz: yup 00:16:18 for that action item 00:16:37 I think Akim got it compiling last week 00:16:39 hi, sorry im here 00:16:49 so had it compiling? 00:16:50 mlemay, yeah got it to work, thanks for the help 00:16:56 ok 00:17:01 i only looked at it that day you talked to me 00:17:05 ok 00:17:06 havent touched it since unfortunately 00:17:18 but i think you guys needed some help on the index styling? 00:17:43 correct may I put out some "things to do?" 00:17:50 yes please 00:17:52 Yes, please! 00:18:35 Can you give them the #action prefix (or do I need to do that as the host? Not sure) 00:18:38 If possible fix the awful other xml guides so that I can apply docbook2asciidoc to them would be on the top of my list ;) 00:18:56 usually only hosts can do it 00:18:59 I think 00:19:14 OK... what do you mean by fix the xml giudes? 00:19:36 Does the content need to be cleaned up somehow? 00:19:41 (the howto-openstack and user-guide) 00:19:42 yes 00:19:46 content needs a cleanup 00:19:54 especially the xml:id for sections 00:20:14 xml:id has to be specified otherwise the toolchain chokes.. these have to be unique 00:20:33 I’ve got the toolchain setup. I can do cleanup with some guidance on how to get this cleanup started 00:20:34 and my writer was a newbie so he simply cut&pasted so it's all wrong and I didn't get a chance to clean that up 00:20:54 ok great sure for the guidance and thanks for volunteering 00:21:04 after at least we'll get all of you out of xml hell :P 00:21:15 #action gjs to sync with mlemay on doc cleanup 00:21:22 Ok, I’m willing to slog through the mess :) 00:22:16 Thanks, Greg! 00:22:18 and we'll convert it all to asciidoc , my update is I should be done with asciidocsupport 00:22:30 got the bugs fixed 00:22:35 so I only need to assemble it now 00:23:07 thanks Greg for the help 00:23:21 ok back to agenda... sorry paul 00:23:24 No prob. I’ll be in touch 00:24:10 No this is perfect! So once Greg has the docs cleaned up, you (Mathieu) will test the assembly... action? 00:24:25 action will be 00:24:31 convert guides to asciidoc 00:24:39 Great! 00:24:44 then I think people will be able to start writing 00:24:51 (in a human way) 00:24:57 #action mlemay to convert guides to asciidoc 00:25:37 k 00:25:46 That actually handled one of our later topics... 00:25:55 Ok, next item... 00:26:08 #topic Proposal Status 00:26:43 Heard from David Meyer... we're on the TSC agenda on Thursday 00:27:11 That's good 00:27:12 10am Pacific, if you can make it... I plan to be there, and I hope they get to us before 11 as I have a tough conflict 00:27:15 ok nice 00:27:22 I might present my project too 00:27:27 (reservation) 00:27:30 Great! Busy day! 00:27:40 but sure it's a 2 in one ;) 00:27:47 I'll definitely be there for docs too 00:27:50 (so important) 00:27:56 Awesome... appreciate it! 00:28:24 Any comments or questions on the proposal? 00:28:45 Nope 00:29:09 looking forward to having the environment up so we can commit directly :) 00:29:19 Here's the link for the call-in for anyone interested... 00:29:23 #link https://wiki.opendaylight.org/view/TSC:Main 00:30:06 OK, the next topic I had we mostly covered, but I'll put it up anyway 00:30:11 #topic Toolchain setup 00:30:22 So we have several actions here already 00:30:48 Any other thoughts on this topic? 00:31:04 thanks paul 00:31:25 Oh, Greg updated the repository setup instructions 00:31:42 #link https://wiki.opendaylight.org/view/CrossProject:Documentation_Group:Tools 00:32:07 If folks haven't done it, it would be good to set up their repositories in preparation for diving in... 00:32:34 Yes I noticed 00:32:39 thanks alot Greg 00:32:48 we'll fix it when we have our repo 00:32:57 I guess it should be a matter of days 00:33:11 really great 00:33:30 Should people wait until the rest of the tooling is set up? 00:34:10 People can use the instructions to get set up. Once I figure out the editing/publishing part, I’ll yupdate the wiki 00:35:10 Thanks!! 00:35:15 ok 00:35:19 great 00:35:30 no they can get started now a bit if they wish 00:35:38 as long as content is asciidoc 00:35:50 I can merge the work in very easily 00:35:57 Gotcha 00:36:41 http://asciidoctor.org/docs/asciidoc-writers-guide/ 00:37:00 Nice! 00:37:38 if I am using windows, howto clone the repositories? anyone knows? 00:37:58 also glossary is a ripoff from Openstack so we might want to get it started properly for ODL 00:38:05 yes 00:38:23 http://msysgit.github.io/ 00:38:30 I used Greg's instructions for my Windows machine and it seemed to work... 00:38:48 thanks :) 00:39:03 I believe the commands are the same regardless of your OS 00:39:50 Ah, Mathieu, that is a perfect segue into the next topic... anything else on toolchain? 00:40:45 yes correct... well apart from asciidoc no.. feel free to send me styling suggestions 00:40:51 or stylesheets 00:40:55 and I,ll bring them in 00:41:05 I need to sort out the maven deploy thing 00:41:12 and maybe the index page 00:41:22 any idea on the index page : 00:41:24 like this: 00:41:46 this is generate: 00:41:51 *generated: http://docs.rackspace.com/ 00:42:12 do we what something like that for projects? 00:42:17 should projects have small logos? 00:42:24 (just throwing out ideas) 00:43:03 Oooo... that page does look pretty good... 00:43:56 how about a team action to give ideas on the index page. I'll put up a wiki page (likely tomorrow) to collect some ideas and everyone will have the action to review by next meeting. 00:45:25 yes sure 00:45:30 #action paulz to create wiki page to collect ideas for index page 00:45:41 #action team to review index page ideas by next meeting. 00:45:53 should it flow with ODL website? 00:46:02 (look and feel wise / navigation?) 00:46:50 I think it should retain some consistency with the ODL site, but can have some unique attributes as well since it has a unique purpose 00:46:57 also how many orgs will want to reuse the work for their internal organisation documentation / rebranding? 00:47:18 just wondering how high priority that is 00:49:07 regarding reuse, probably several orgs will want it... priority-wise, good question... we should have a model in place so that we are organizing the content properly from day 1, but it will take some time to build out the content... 00:50:30 Colin, any thoughts on prioritizing the index page? 00:51:30 ok looks like I have some basic time ahead to improve stylesheet branding and have an extension mechanism ... for now we'll have to live with ODL brand for a bit 00:52:28 I guess my opinion is that the tooling/asciidoc is a higher priority as we can't get started without it. After that, the doc organization should be in place, so we have a model to work from as far as content types, etc. 00:52:52 Then, it would be content development, and then the actual index page build 00:53:51 ok 00:53:56 works for me 00:54:24 sounds like a plan 00:54:28 anything else? 00:54:53 Cool! We're almost out of time... I had one more topic, but it can probably be tabled for next time (can't get into it until we can build docs) 00:55:34 Well, I'll add a quick note anyway 00:55:34 I wanted to discuss putting design docs on the wiki (e.g., templates) 00:55:46 but this too can wait 00:55:59 OK, let's put that on the agenda for next time 00:56:10 k 00:56:28 #action paulz to have Content ownership and design docs/templates on the agenda for next time 00:57:02 Alright, anything else for either today or next time? 00:57:27 I'm good my 00:57:36 *myself 00:59:19 OK, no other comments, I guess we can wrap it for today! 00:59:30 Thanks, everyone!! 00:59:57 Bye 01:00:16 #endmeeting