| *** cdub has joined #openstack-meeting | 00:06 | |
| *** AlanClark has quit IRC | 00:25 | |
| *** cdub has quit IRC | 00:27 | |
| *** cdub has joined #openstack-meeting | 00:59 | |
| *** AlanClark has joined #openstack-meeting | 01:49 | |
| *** jaypipes has joined #openstack-meeting | 01:54 | |
| *** AlanClark has quit IRC | 01:58 | |
| *** shang has joined #openstack-meeting | 02:11 | |
| *** jakedahn has quit IRC | 05:41 | |
| *** reed_ has quit IRC | 05:52 | |
| *** sandywalsh has quit IRC | 06:46 | |
| *** jeblair has quit IRC | 06:46 | |
| *** markwash has quit IRC | 06:46 | |
| *** jamespage has quit IRC | 06:46 | |
| *** sandywalsh has joined #openstack-meeting | 06:49 | |
| *** jeblair has joined #openstack-meeting | 06:49 | |
| *** markwash has joined #openstack-meeting | 06:49 | |
| *** jamespage has joined #openstack-meeting | 06:49 | |
| *** lloydde has joined #openstack-meeting | 08:00 | |
| *** nevrax has joined #openstack-meeting | 08:12 | |
| *** GheRivero has joined #openstack-meeting | 08:13 | |
| *** lloydde has quit IRC | 08:47 | |
| *** hggdh has joined #openstack-meeting | 09:39 | |
| *** darraghb has joined #openstack-meeting | 09:49 | |
| *** zul has joined #openstack-meeting | 10:31 | |
| *** hggdh has quit IRC | 11:56 | |
| *** zul has quit IRC | 11:56 | |
| *** markvoelker has joined #openstack-meeting | 12:46 | |
| *** zul has joined #openstack-meeting | 12:51 | |
| *** ayoung has joined #openstack-meeting | 13:33 | |
| *** jamespage_ has joined #openstack-meeting | 13:33 | |
| *** jamespage_ has quit IRC | 13:38 | |
| *** hggdh has joined #openstack-meeting | 13:45 | |
| *** mestery has quit IRC | 14:12 | |
| *** dprince has joined #openstack-meeting | 14:24 | |
| *** dolphm has joined #openstack-meeting | 14:32 | |
| *** mestery has joined #openstack-meeting | 14:33 | |
| *** dolphm has quit IRC | 14:44 | |
| *** LuizOz has quit IRC | 14:55 | |
| *** LuizOz has joined #openstack-meeting | 15:05 | |
| *** dolphm has joined #openstack-meeting | 15:08 | |
| *** GheRivero_ has joined #openstack-meeting | 15:11 | |
| *** LuizOz has quit IRC | 15:18 | |
| *** reed_ has joined #openstack-meeting | 15:23 | |
| *** mattray has joined #openstack-meeting | 15:31 | |
| *** AlanClark has joined #openstack-meeting | 15:43 | |
| *** deshantm has joined #openstack-meeting | 15:51 | |
| *** adjohn has joined #openstack-meeting | 15:55 | |
| *** GheRivero_ has quit IRC | 15:56 | |
| *** GheRivero_ has joined #openstack-meeting | 15:56 | |
| *** dolphm has quit IRC | 16:01 | |
| *** mattray has quit IRC | 16:04 | |
| *** dolphm has joined #openstack-meeting | 16:05 | |
| *** mattray has joined #openstack-meeting | 16:06 | |
| *** GheRivero_ has quit IRC | 16:14 | |
| *** GheRivero_ has joined #openstack-meeting | 16:14 | |
| *** rnirmal has joined #openstack-meeting | 16:15 | |
| *** GheRivero_ has quit IRC | 16:21 | |
| *** GheRivero_ has joined #openstack-meeting | 16:21 | |
| *** GheRivero_ has quit IRC | 16:26 | |
| *** GheRivero_ has joined #openstack-meeting | 16:26 | |
| *** GheRivero_ has quit IRC | 16:27 | |
| *** GheRivero_ has joined #openstack-meeting | 16:27 | |
| *** GheRivero_ has quit IRC | 16:30 | |
| *** GheRivero_ has joined #openstack-meeting | 16:30 | |
| *** GheRivero_ has quit IRC | 16:31 | |
| *** GheRivero_ has joined #openstack-meeting | 16:31 | |
| *** GheRivero_ has quit IRC | 16:32 | |
| *** GheRivero_ has joined #openstack-meeting | 16:32 | |
| *** GheRivero_ has quit IRC | 16:33 | |
| *** GheRivero_ has joined #openstack-meeting | 16:33 | |
| *** GheRivero_ has quit IRC | 16:33 | |
| *** adjohn has quit IRC | 16:42 | |
| *** deshantm_ has joined #openstack-meeting | 16:43 | |
| *** adjohn has joined #openstack-meeting | 16:43 | |
| *** Gordonz has joined #openstack-meeting | 16:44 | |
| *** nevrax has quit IRC | 16:46 | |
| *** deshantm has quit IRC | 16:47 | |
| *** adjohn has quit IRC | 16:47 | |
| *** oubiwann has joined #openstack-meeting | 16:53 | |
| *** dolphm has quit IRC | 16:56 | |
| *** dolphm has joined #openstack-meeting | 17:01 | |
| *** zul has quit IRC | 17:04 | |
| *** dwcramer has joined #openstack-meeting | 17:11 | |
| *** lloydde has joined #openstack-meeting | 17:12 | |
| *** hggdh has quit IRC | 17:13 | |
| *** openstack has joined #openstack-meeting | 17:24 | |
| *** ChanServ sets mode: +o openstack | 17:24 | |
| *** GheRivero has quit IRC | 17:30 | |
| *** mattray has quit IRC | 17:34 | |
| *** dolphm has quit IRC | 17:38 | |
| *** dolphm has joined #openstack-meeting | 17:43 | |
| *** GheRivero has joined #openstack-meeting | 17:43 | |
| *** dolphm has quit IRC | 17:49 | |
| *** deshantm_ has quit IRC | 17:49 | |
| *** jdurgin has joined #openstack-meeting | 17:55 | |
| *** deshantm has joined #openstack-meeting | 18:02 | |
| *** novas0x2a|laptop has joined #openstack-meeting | 18:03 | |
| *** adjohn has joined #openstack-meeting | 18:05 | |
| *** mattray has joined #openstack-meeting | 18:06 | |
| *** adjohn has quit IRC | 18:07 | |
| *** adjohn has joined #openstack-meeting | 18:07 | |
| *** sleepsonthefloo has joined #openstack-meeting | 18:15 | |
| *** darraghb has quit IRC | 18:20 | |
| *** gyee has joined #openstack-meeting | 18:31 | |
| *** bengrue has joined #openstack-meeting | 18:57 | |
| *** davlap has joined #openstack-meeting | 19:05 | |
| *** jog0 has joined #openstack-meeting | 19:32 | |
| *** GheRivero_ has joined #openstack-meeting | 19:37 | |
| *** nati2 has joined #openstack-meeting | 19:38 | |
| *** GheRivero_ has quit IRC | 19:38 | |
| *** GheRivero_ has joined #openstack-meeting | 19:39 | |
| *** GheRivero_ has quit IRC | 19:47 | |
| *** GheRivero_ has joined #openstack-meeting | 19:48 | |
| *** phantomcircuit has joined #openstack-meeting | 19:52 | |
| *** dolphm has joined #openstack-meeting | 19:58 | |
| annegentle | Anyone around for the doc Team meeting? | 20:02 |
|---|---|---|
| deshantm | i'm here | 20:02 |
| annegentle | Great, good to see you! | 20:02 |
| annegentle | sorry I'm always 2-3 minutes late | 20:02 |
| annegentle | :) | 20:02 |
| deshantm | annegentle: good to see you too! | 20:02 |
| annegentle | I think I'll get started. | 20:03 |
| annegentle | #startmeeting | 20:03 |
| openstack | Meeting started Mon Jan 9 20:03:16 2012 UTC. The chair is annegentle. Information about MeetBot at http://wiki.debian.org/MeetBot. | 20:03 |
| openstack | Useful Commands: #action #agreed #help #info #idea #link #topic. | 20:03 |
| annegentle | #info Agenda at http://wiki.openstack.org/Meetings/DocTeamMeeting | 20:03 |
| annegentle | #topic New incoming documents | 20:03 |
| *** openstack changes topic to "New incoming documents" | 20:03 | |
| annegentle | I've been talking with collaborators about new docs and have been working on one myself with lots of input and reviews | 20:04 |
| annegentle | #info New install doc with instructions for Cloud Builders packages at https://github.com/annegentle/openstack-manuals/tree/installdocs | 20:04 |
| annegentle | Once I get the testing done, which is going slowly, I'll publish it as a standalone document | 20:05 |
| annegentle | I've also been talking to collaborators at HP about putting some docs onto the docs.openstack.org site, and will keep working on it this month | 20:05 |
| *** GheRivero_ has quit IRC | 20:05 | |
| annegentle | I feel a little bit like I'm just catching up with Diablo and Essex is around the corner. | 20:05 |
| *** GheRivero_ has joined #openstack-meeting | 20:06 | |
| annegentle | The third "book" incoming is a Python guide for using the Compute API | 20:06 |
| deshantm | nice | 20:06 |
| deshantm | I'd love to take a look | 20:06 |
| annegentle | #info Working with Devguide.net author for a Python guide for using the Compute API | 20:06 |
| annegentle | And lastly, I've got a half-done API Quick Start guide in the openstack-manuals repository | 20:06 |
| deshantm | I've started reading through the nova.openstack.org docs | 20:07 |
| deshantm | I have a few small edits that I haven't pushed anywhere yet | 20:07 |
| annegentle | Ideally the API Quick Start will be linked from api.openstack.org | 20:07 |
| annegentle | deshantm: that would be fabulous, edits for that site usually get reviewed and in quickly so feel free to push 'em | 20:07 |
| annegentle | As you can see from that list of new incoming docs, still no author for a Xen or XenServer chapter/book. | 20:08 |
| annegentle | So we still point people to the wiki page at http://wiki.openstack.org/XenServerDevelopment | 20:08 |
| annegentle | Ah well. | 20:08 |
| deshantm | what is the write process to turn my etherpad notes into something useful? | 20:08 |
| *** GheRivero_ has quit IRC | 20:08 | |
| annegentle | Still time to find that author :) | 20:08 |
| annegentle | deshantm: just like code, send it through the Gerrit process for review | 20:09 |
| *** GheRivero_ has joined #openstack-meeting | 20:09 | |
| annegentle | http://wiki.openstack.org/GerritWorkflow and also http://wiki.openstack.org/Documentation/HowTo | 20:09 |
| deshantm | I have this so far, and will continue on it: http://etherpad.openstack.org/openstack-xen | 20:09 |
| annegentle | #link http://etherpad.openstack.org/openstack-xen | 20:09 |
| annegentle | Yes, I'd like to get that into openstack-manuals when you think it's ready. | 20:10 |
| deshantm | I have a lot of content from presentations I've done on the topic to incorporate still | 20:10 |
| annegentle | deshantm: yeah, feel free to keep polishing and adding and rounding | 20:10 |
| *** GheRivero_ has quit IRC | 20:10 | |
| annegentle | #topic Making review diffs easier | 20:11 |
| *** openstack changes topic to "Making review diffs easier" | 20:11 | |
| *** GheRivero_ has joined #openstack-meeting | 20:11 | |
| annegentle | I've gotten feedback that it's tough to compare XML doc differences. | 20:11 |
| annegentle | So I've started investigating alternatives for the review. | 20:11 |
| annegentle | reviewing comparisons between output rather than input, is one idea | 20:11 |
| annegentle | #link http://docs.openstack.org/trunk/cs-devguide-diff/content/Overview-d1e71.html | 20:11 |
| annegentle | this is an example of a diff done with a tool called deltaxml | 20:12 |
| deshantm | that seems nice | 20:12 |
| annegentle | Wanted to bring it to this meeting so people could poke at it a bit and see if it's worth exploring further. It is proprietary software, costing about $2000 for the first 3 years with maintenance costs as well, plus the cost of integrating with Gerrit. | 20:12 |
| annegentle | So yes, it's costly, proprietary, but it does seem nicer than stuff like this: https://review.openstack.org/#patch,sidebyside,2824,1,doc/src/docbkx/openstack-compute-admin/aboutcompute.xml | 20:13 |
| annegentle | I'll shop around the idea to get more input. | 20:13 |
| annegentle | ok, on to another topic, source files | 20:15 |
| annegentle | #topic Mixing source content | 20:15 |
| *** openstack changes topic to "Mixing source content" | 20:15 | |
| deshantm | I'm surprised there isn't an open source alternative for the XML diffing | 20:15 |
| annegentle | deshantm: good point, we didn't find any (David Cramer and me) but more eyes looking, the better | 20:15 |
| annegentle | I know that people like RST and asciidoc and markdown for the simplicity of markup. | 20:16 |
| annegentle | Are there any problems with having openstack-manuals have any type of source content? | 20:16 |
| annegentle | I'm thinking about putting markdown and docbook in openstack-manuals as source but still outputting html and pdf. Any thoughts? | 20:17 |
| deshantm | so in addition to the xml stuff? | 20:17 |
| annegentle | deshantm: right, XML for some of the books, markdown for another, and so on. | 20:18 |
| annegentle | deshantm: if I could automate it, I suppose going markdown > docbook > output would make sense | 20:18 |
| annegentle | for consistency's sake in branding/styling the output | 20:18 |
| annegentle | deshantm: making docbook the "interpretation" that goes to output, but still enabling authors to write in what they like | 20:19 |
| deshantm | personally i like simpler and the more plain the better, but I think some people that do docs probably like IDEs that do lots of formatting | 20:19 |
| annegentle | and reviews may be easier in markdown | 20:19 |
| deshantm | so people would have the choice of the markdown or docbook then? | 20:20 |
| annegentle | deshantm: I think the fluidity of the content is the pull to XML for me - if you take a look at the openstack-install folder in https://github.com/annegentle/openstack-manuals/tree/installdocs you can see more "topic" authoring - instead of per chapter, writing per "topic" and gluing it all together with xi:includes | 20:20 |
| annegentle | deshantm: I don't yet see a good way to cross link Sphinx sites, for example. And a markdown document is quite standalone | 20:20 |
| annegentle | Still, I want to enable content creation, ya know? | 20:21 |
| deshantm | yeah, the more the better | 20:22 |
| annegentle | #topic API quick start and reference page progress | 20:22 |
| *** openstack changes topic to "API quick start and reference page progress" | 20:22 | |
| dwcramer | What about a model where content is initially created in whatever format the contributors prefer and later upcast to the richer format? | 20:22 |
| deshantm | i think enabling markdown and seeing if people use it is a low risk option | 20:22 |
| annegentle | deshantm: ok, yeah, markdown is good for experimenting with since I have a new guide in markdown | 20:23 |
| annegentle | dwcramer: yes, I agree with upcast as a model. Seems like best of "all" worlds. | 20:23 |
| *** dolphm has quit IRC | 20:24 | |
| annegentle | Sorry if I changed topics too quick :) | 20:24 |
| annegentle | So, the mockup site at http://heckj.github.com/api-site-mock/ has been updated with a search box, (yeah!) and some additional content. | 20:24 |
| annegentle | I think I have lots of "blessings" on the mockup. | 20:24 |
| annegentle | So I feel quite comfortable going forward with it. | 20:25 |
| annegentle | I talked at the last openstack-qa meeting about getting help with creating WADLs to form the site content. The QA attendees like the mockup and offered to help. | 20:25 |
| deshantm | you know what would be cool on that page... an autocompletion feature. So you type /server/i and it auto completes image for example | 20:25 |
| annegentle | deshantm: so it sort of does autocomplete already, just in highlighters in the text below. | 20:26 |
| annegentle | deshantm: type "serv" and you see the highlighting below | 20:26 |
| dwcramer | I see what he means though...a box for just the paths. | 20:26 |
| dwcramer | I'll add a story to the backlog. | 20:27 |
| dwcramer | Tab completion makes me happy too. | 20:27 |
| deshantm | the other thing that would be nice to see somewhere on this page is an object model | 20:27 |
| annegentle | deshantm: yeah makes sense, thanks for adding it dwcramer | 20:27 |
| deshantm | just at a high level how things hook together | 20:27 |
| annegentle | deshantm: oh, what does that look like? | 20:27 |
| annegentle | deshantm: one model site for our mockup was https://dev.twitter.com/docs/api | 20:28 |
| deshantm | something like: http://docs.vmd.citrix.com/XenServer/4.1.0/1.0/en_gb/api/docs/html/browser.html | 20:28 |
| annegentle | deshantm: oh, how was that put together, do you know? | 20:28 |
| deshantm | I don't know actually, but I could ask around to try to find out | 20:29 |
| annegentle | deshantm: sure, thanks | 20:30 |
| deshantm | my vague recollection is that it was something they were able to automate with Ocaml... | 20:30 |
| annegentle | #action deshantm to look for source and toolchain of http://docs.vmd.citrix.com/XenServer/4.1.0/1.0/en_gb/api/docs/html/browser.html | 20:30 |
| annegentle | deshantm: automation is good :) | 20:30 |
| annegentle | deshantm: with WADL generating the api site, we do get some "automation" but it's not exactly straight from code | 20:30 |
| annegentle | We do have a tool for helping with WADL writing, dwcramer do you have that link handy? | 20:32 |
| dwcramer | https://github.com/rackspace/wadl-tools/ | 20:32 |
| annegentle | #link https://github.com/rackspace/wadl-tools | 20:32 |
| annegentle | dwcramer: thanks | 20:33 |
| dwcramer | Used in conjunction with oXygen. | 20:33 |
| annegentle | And oXygen licenses are free to OpenStack contributors | 20:33 |
| *** jakedahn has joined #openstack-meeting | 20:33 | |
| annegentle | Jay Pipes has agreed to write a WADL for the object-api (Swift) | 20:33 |
| annegentle | We have a WADL in review for the image-api, one for compute-api, and several for identity-api (though they're in the Keystone repo) | 20:34 |
| deshantm | annegentle: it is autogenerated from source: http://community.citrix.com/display/xs/Exploring+XAPI | 20:34 |
| annegentle | So we're nearly set with the content to fill in the mockup and coincide with the Essex release | 20:34 |
| annegentle | That's all on the agenda. | 20:35 |
| annegentle | # topic Open Discussion | 20:35 |
| deshantm | annegentle: https://github.com/xen-org/xen-api/blob/master/ocaml/doc/doc.py | 20:37 |
| deshantm | i think that is probably it or some of it | 20:37 |
| deshantm | my guess is that it is specific to ocaml that xapi is written in, but it is in python so it may be able to be generalized to work with the OpenStack API | 20:38 |
| deshantm | I bet there is a tool that could generate a class diagram given python code | 20:40 |
| deshantm | the question is, what does the API look like in code at the moment? | 20:41 |
| deshantm | is it a set of inter-related classes? | 20:41 |
| deshantm | or is it more stand-alone modules? | 20:41 |
| deshantm | it is RESTful | 20:41 |
| annegentle | it is RESTful | 20:41 |
| annegentle | but I haven't dug into the code well enough to know if it's modules or classes | 20:42 |
| annegentle | my attempts to get an auto-generated solution have come up flat... :) | 20:43 |
| deshantm | so maybe it is not necessary, but some high level picture is always useful to get a quick overview | 20:43 |
| annegentle | deshantm: yes I like the idea of a diagram somewhere but this site is meant for lookup/reference more than conceptual overview | 20:43 |
| annegentle | the API Quick Start definitely should have a diagram though | 20:43 |
| annegentle | showing the relatedness of each API to the other | 20:43 |
| deshantm | in the end, devs will dig into the details, but if people teaching the API have a picture to point to, it can help their students | 20:43 |
| deshantm | just quick impression thoughts is all | 20:44 |
| annegentle | deshantm: yes, thanks for that | 20:45 |
| deshantm | i don't have anything else | 20:45 |
| annegentle | and sorry for my slowness responding, interuptions abound! | 20:45 |
| deshantm | (for now) | 20:45 |
| deshantm | no worries | 20:45 |
| annegentle | ok, that's all I have for now, seems monthly meetings are still okay. | 20:45 |
| annegentle | I'll report at tomorrow's team meeting about this one. | 20:45 |
| annegentle | but that's it! Thanks for coming. | 20:45 |
| annegentle | #endmeeting | 20:45 |
| *** openstack changes topic to "Openstack Meetings: http://wiki.openstack.org/Meetings | Minutes: http://eavesdrop.openstack.org/meetings/openstack-meeting/2011/" | 20:45 | |
| openstack | Meeting ended Mon Jan 9 20:45:54 2012 UTC. Information about MeetBot at http://wiki.debian.org/MeetBot . (v 0.1.4) | 20:45 |
| openstack | Minutes: http://eavesdrop.openstack.org/meetings/openstack-meeting/2012/openstack-meeting.2012-01-09-20.03.html | 20:45 |
| openstack | Minutes (text): http://eavesdrop.openstack.org/meetings/openstack-meeting/2012/openstack-meeting.2012-01-09-20.03.txt | 20:45 |
| openstack | Log: http://eavesdrop.openstack.org/meetings/openstack-meeting/2012/openstack-meeting.2012-01-09-20.03.log.html | 20:45 |
| *** jog0 has left #openstack-meeting | 20:47 | |
| *** dprince has quit IRC | 20:49 | |
| *** nati2 has quit IRC | 21:05 | |
| *** patelna has joined #openstack-meeting | 21:35 | |
| *** Ravikumar_hp has joined #openstack-meeting | 21:37 | |
| *** GheRivero_ has quit IRC | 21:40 | |
| *** GheRivero_ has joined #openstack-meeting | 21:41 | |
| *** GheRivero_ has quit IRC | 21:43 | |
| *** GheRivero_ has joined #openstack-meeting | 21:44 | |
| *** GheRivero_ has quit IRC | 21:48 | |
| *** GheRivero_ has joined #openstack-meeting | 21:48 | |
| *** dolphm has joined #openstack-meeting | 21:49 | |
| *** GheRivero_ has quit IRC | 21:51 | |
| *** GheRivero_ has joined #openstack-meeting | 21:52 | |
| *** GheRivero_ has quit IRC | 21:53 | |
| *** GheRivero_ has joined #openstack-meeting | 21:54 | |
| *** GheRivero_ has quit IRC | 21:56 | |
| *** GheRivero_ has joined #openstack-meeting | 21:57 | |
| *** GheRivero_ has quit IRC | 22:08 | |
| *** GheRivero_ has joined #openstack-meeting | 22:09 | |
| *** ayoung has quit IRC | 22:13 | |
| *** GheRivero_ has quit IRC | 22:13 | |
| *** ayoung has joined #openstack-meeting | 22:13 | |
| *** GheRivero_ has joined #openstack-meeting | 22:13 | |
| *** Ravikumar_hp has quit IRC | 22:28 | |
| *** dolphm has quit IRC | 22:31 | |
| *** oubiwann1 has joined #openstack-meeting | 22:33 | |
| *** oubiwann has quit IRC | 22:35 | |
| *** dwcramer has quit IRC | 23:20 | |
| *** AlanClark has quit IRC | 23:34 | |
| *** donaldngo_hp has joined #openstack-meeting | 23:42 | |
| *** mattray has quit IRC | 23:53 | |
| *** _adjohn has joined #openstack-meeting | 23:54 | |
| *** adjohn has quit IRC | 23:55 | |
| *** _adjohn is now known as adjohn | 23:55 | |
| *** adjohn has quit IRC | 23:59 | |
| *** adjohn has joined #openstack-meeting | 23:59 | |
Generated by irclog2html.py 2.14.0 by Marius Gedminas - find it at mg.pov.lt!