03:06:53 #startmeeting docteam 03:06:53 Meeting started Wed Jul 2 03:06:53 2014 UTC and is due to finish in 60 minutes. The chair is loquacities. Information about MeetBot at http://wiki.debian.org/MeetBot. 03:06:54 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 03:06:56 The meeting name has been set to 'docteam' 03:07:19 just pulling up the logs from the last US meeting ... 03:07:53 #topic Action items from the last meeting 03:08:10 Anne to send IBM Style Guide Kindle to berendt 03:08:11 Anne to send IBM Style Guide Kindle to phil_h 03:08:18 that's it! 03:08:29 anyone in APAC need an IBM book? 03:08:31 it was a little nonexistant 03:08:52 although i did find it interesting that the ibm style guide suggests gerunds for titles :P 03:09:01 good! 03:09:04 * loquacities likes gerunds 03:09:16 I don't think I have the accounts for those two, will follow up. 03:09:23 i assume the red hatters have IBM books already 03:09:31 and i know i've asked you to send some to my team 03:09:33 I have print copies in Austin so let me know if you want one 03:09:50 yup.. we do 03:10:05 cool 03:10:10 #topic Discuss a doc-spec repo and doc-spec template 03:10:37 loquacities: those arrived in destination country yesterday :) 03:10:43 is this a replacement for blueprints? 03:10:45 annegentle: did you want to talk about the doc-spec stuff? 03:10:46 o/ 03:10:48 sure 03:10:58 oh, cool, i should have them any day then 03:11:01 Sam-I-Am: docs-spec template replaces the wiki page link 03:11:09 blueprints are still tracked in Launchpad 03:11:21 #link https://review.openstack.org/#/c/103115/ 03:11:23 hmm ok 03:11:26 the template is there ^^ 03:11:44 I'm going to make one more tweak I think -- I did an informal poll about who the review team typically is 03:11:55 the way it's set up now, it'll be a separate team from docs-core 03:11:59 who approves blueprints 03:12:10 eeeeeo yaml 03:12:14 some projects do it that way 03:12:26 hrm, ok 03:12:47 hmph loquacities 03:12:53 heya asettle :) 03:12:59 #link https://github.com/annegentle/docs-specs/blob/master/template.rst 03:13:04 ^^ that's the template 03:13:19 sorry misplaced link 03:13:28 that works 03:13:43 I sent an email Monday (your Tues) that talks about the balancing act here 03:13:52 I only want up front design for large changes 03:14:00 otherwise, just effing write for pity's sake 03:14:09 LOL 03:14:11 :) 03:14:17 loquacities: I thought you'd appreciate that 03:14:23 don't write to write, just write. 03:14:24 i think that's a very sane approach :) 03:14:38 I don't want heavy handed reviews either 03:14:48 ahhh well crap, you've come to the wrong place 03:14:53 so I _think_ (but want input) that a small core review team makes sense 03:15:02 yeah, possibly 03:15:18 the problem with that is what happens as people drift away or get preoccupied 03:15:41 small core review team? Or specs not getting enough updates? 03:15:49 small core team 03:16:29 yeah. could just be me, Sean, Andreas, and Brian to cover the projects within Docs. training, tools, security 03:16:45 and that seems ok for the workload, we only have 3 to review for juno 03:16:47 yeah, i worry about failover 03:16:58 but we can probably deal with that as it arises anyway 03:16:59 yeah release to release who knows 03:17:11 +1 03:17:16 dont get hit by a bus 03:17:20 +1 03:17:21 +1 :) 03:17:24 lol 03:17:28 #topic Training-guides now in Docs program; security-guide now in Docs program 03:17:35 heh I'm a very careful driver 03:17:55 so those were both voted in by the TC with no questions or concerns 03:18:07 yeah, not sure there's much more we need to say there 03:18:11 yup 03:18:14 but there it is, in case anyone didn't notice 03:18:21 news blast! :) 03:18:22 wish i had more time to get involved in the training guides 03:18:25 #topic Discuss publishing to /dev; /current; /drafts; other ideas 03:18:42 Sam-I-Am: just keep doing good install guides and they'll benefit :) 03:18:53 yeah, true that 03:18:56 sure 03:19:10 so yeah, this... differentiation of docs 03:19:19 yeah, i don't think i'm up on this bit 03:19:22 also need to keep google's nose out of things 03:19:47 there's an e-mail thread on the list about it 03:19:49 oh, because it's indexing /dev? 03:19:55 well, /trunk 03:19:55 i think i saw that on a patch 03:20:00 right 03:20:17 seems like the workaround is pretty kludgy 03:20:19 yeah the /trunk naming was a holdover from bazaar/bzr days 03:20:29 with the install guide in particular, people liked trunk because it usually had less bugs.. or something. 03:20:32 git calls it master, bzr calls it trunk 03:20:46 i think its trunk in svn too 03:20:49 #link http://lists.openstack.org/pipermail/openstack-docs/2014-June/004664.html 03:20:51 dammit, open source 03:21:26 another possibly similar question came up early with the api docs. how does one know which api version applies to which release(s) ? 03:21:31 do we have the capability of doing watermarks or something? 03:21:37 loquacities: yes 03:21:41 i havent had much time to look into it, but it seemed like a valid concern 03:21:55 can we watermark web pages? 03:22:06 Sam-I-Am: there's no match because for example Keystone v3 can run on havana or icehouse. It's provider choice. 03:22:07 docbook is capable, as long as our CSS is 03:22:09 Sam-I-Am: yes 03:22:19 loquacities: Sam-I-Am: there's a setting in the pom.xml 03:22:25 cool 03:22:38 so maybe we could watermark with the release name or something for things in /trunk? 03:22:39 so, draft? 03:22:56 "don'tcomplainifthisdoesn'twork" 03:22:56 yeah, draft is probably adequate 03:22:59 lol 03:23:23 draft seems pretty standard 03:23:38 "very drafty" ? 03:23:48 brucer: will give you the sniffles 03:23:51 hehe 03:23:52 (= full of holes?) 03:24:07 and then to keep the googles away 03:24:08 works but only if you install from source 03:24:24 also still have that bug open about marking outdated stuff 03:24:29 seems like we could do this just for the install guide 03:24:34 i still have tons of grizzly stuff come up on my searches 03:24:35 #link https://bugs.launchpad.net/openstack-manuals/+bug/1191447 03:24:37 Launchpad bug 1191447 in openstack-manuals "Clearly mark outdated doc pages" [Critical,Confirmed] 03:24:44 annegentle: any doc with a specific releace cycle 03:24:52 i imagine you could use a watermark for that too 03:24:55 fifieldt said in the comments he didn't think a watermark helped, but we can overrule :) 03:24:57 or any new doc, perhaps 03:25:06 although possibly now that i have a hammer, everything is looking like a nail 03:25:08 Sam-I-Am: install and config are only two matching a release cycle 03:25:34 its interesting that most of the time, google returns grizzly docs. i wonder what happened in grizzly that made google happy. 03:25:35 loquacities: that does happen but I do think the watermark is a known standard and we should at least use it since it's at our disposal 03:25:44 yeah, agreed 03:25:47 Sam-I-Am: everyone's still referring to those because they still run grizzly 03:25:49 it doesn't seem too crazy 03:25:54 and it works around the google problem 03:25:58 loquacities: +1 for not-crazy 03:26:07 there's a LOT of grizzly installs out there, i think 03:26:15 did we have a way in mind to prevent indexing of draft? 03:26:17 yes based on the user survey 03:26:40 Sam-I-Am: the sitemap has been updated to remove /trunk (and nothing else is added) 03:26:53 so I think this is fairly well sorted, the next step would be watermark 03:26:59 ok, cool 03:27:07 APAC docs team next problem: world hunger 03:27:08 multiple steps after that would be a complete redesign but that's not the scope 03:27:19 whirled peas 03:27:34 loquacities: more like eppo 03:27:35 mmm ... tasty .... 03:27:40 #topic New glance team mission means possible Image Service rename 03:27:45 Sam-I-Am: sworld peace would be easier 03:27:50 so I would looooove input here 03:27:53 #link https://review.openstack.org/#/c/98002/. 03:27:58 #link https://review.openstack.org/#/c/98002/ 03:28:04 sorry, random period crept in there 03:28:29 i guess this isnt a huge deal 03:28:32 just a lot of work 03:29:05 "artifact repository"? 03:29:09 who comes up with this stuff? 03:29:14 however, continous release docs might confuse people using earlier versions 03:29:19 Sam-I-Am: my sense of it is we can refer to the image service when it's serving images, it just won't be the OpenStack Image Service 03:29:28 loquacities: tee hee 03:29:38 concern with repository is that it's not actually storing 03:29:46 yeah 03:29:48 artifact catalog is closer to technically accurate 03:29:48 is there a doc bug raised for this one? 03:29:51 and the term is way overused, too 03:29:59 the word artifact is meh 03:29:59 dnavale: not that I know of, good idea for tracking 03:30:16 i haven't seen a doc bug 03:30:23 how about just... catalog 03:30:35 or thingcubator 03:30:49 i'll raise one 03:30:52 lol 03:31:06 and Sam-I-Am: that sounds awesome 03:31:38 i think i want to dive into this more before i comment 03:31:46 just saying there's other, potentially more fun names 03:31:55 it will enable versioning of the images or templates it gives you 03:32:02 artifacts are what happens when your mpeg stream breaks up 03:32:05 really the artifact for starters is either an image or a heat template 03:32:30 isn't that artefact? 03:32:34 or did i make that up? 03:32:53 loquacities: oh! perhaps that's brit spelling? 03:32:56 hrm, actually google thinks that's a US/UK english thing 03:32:56 * annegentle looks it up 03:33:12 i thought they had two separate meanings, but apparently not 03:33:29 well, synonyms for it are... bleh 03:33:38 anyway, we've digressed 03:33:43 #topic Installation guide improvements 03:33:51 Sam-I-Am: i believe this is dear to your heart? 03:34:02 i guess 03:34:09 multiple people are taking part in it 03:34:14 we're slowly slogging through it 03:34:31 excellent 03:34:33 ideally i'd like at least the 'core' chapters done in time for the first juno packages to drop 03:34:35 glad you've got help :) 03:34:40 then focus turns to trying to install juno 03:34:48 yes me too, plenty to do on that list 03:34:48 heh, it's never ending :) 03:35:01 #topic Conventions and review guide 03:35:13 yes... this. 03:35:16 has anything been decided here? 03:35:20 we originally had the review book 03:35:24 then we decided to keep it wiki 03:35:30 +1 03:35:39 andreas was going to restructure the wiki to make it more useful, then went on vacation 03:35:48 the review guide was waiting on those changes 03:35:50 heh 03:36:01 yeah I'm not sure if that needed to go back on the agenda, nothing new that I know of 03:36:06 there is a lackluster review guide page on the wiki 03:36:08 ok, cool 03:36:18 annegentle: i put it there because i wondered why there hasnt been progress 03:36:24 Sam-I-Am: ah 03:36:28 Sam-I-Am: impatient you are 03:36:30 the review guide is important, especially with a release coming up 03:36:34 true 03:36:43 we're the #1 -1 team lol 03:36:46 Sam-I-Am: we're not even to milestone-2 03:37:04 it's very easy to get bored of this work, though 03:37:13 so i guess it's good to keep it on the agenda and poking people 03:37:17 true loquacities 03:37:21 ok, moving on 03:37:26 #topic Doc tools updates - xi include more than once; swift options 03:37:44 oh, i saw that update 03:37:50 so the xi:include enhancements is in 2.0.2 I believe 03:37:54 excellent 03:38:01 that will help us a lot, too 03:38:20 #link https://github.com/stackforge/clouddocs-maven-plugin#clouddocs-maven-plugin-210-june-23-2014 03:38:26 nope 2.1.0 03:38:42 I released 0.16 of openstack-doc-tools today 03:39:01 #link https://github.com/openstack/openstack-doc-tools#016 03:39:01 oh cool 03:39:24 darrenc: ^^ just wanted to make sure you saw this 03:39:27 so now you can sorta kinda maybe sorta scrape the swift sample config files for descriptions 03:39:36 lol 03:39:52 * darrenc looking 03:39:58 but I did send a note to the -dev mailing list asking for more descriptions as many are blank for entire portions of configuration 03:40:06 there's mail from david cramer on the OS docs list on 25 june 03:40:17 yep 03:40:36 ok, that's everything on the agenda 03:40:41 #topic Open discussion 03:41:08 any other business? 03:41:09 how's continuity with the people changes lately? 03:41:20 i see anne is still breathing 03:41:28 We do have a backfill for David Cramer 03:41:30 #link http://rackspace.jobs/austin-tx/software-developer-iii/0ACE3ABF718D436DACDAFCC783733CD2/job/ 03:41:35 hopefully that's not gauche to post here 03:41:58 hrm, is that strictly austin-based? 03:42:05 ooh, i could work at rackspace 03:42:12 lol 03:42:34 loquacities: I wouldn't say so but that's the system. The manager's in SA so I'm guessing it's due to the backfill nature. 03:42:36 Sam-I-Am: yeah, you *could* :P 03:42:38 and then backfill for Diane 03:42:42 #link http://rackspace.jobs/austin-tx/senior-information-developer/84E2230D7FD0451489FE34AFC5F8C163/job/ 03:42:46 yep, fair enough 03:42:58 huh, i thought her title was software developer 03:42:59 besides, Austin is great :) 03:43:01 i might send it to some people here, anyway, it can't hurt 03:43:03 which is what had me all confused 03:43:13 Sam-I-Am: yes, not what we got with what we have though 03:43:39 hey, *i* was a software developer for a few months when i first started too :P 03:43:47 Sam-I-Am: vague way of saying "it's complicated" 03:43:53 loquacities: oh yeah! :) 03:44:12 heh 03:44:15 everything is complicated... 03:44:27 loquacities: you're still one in your spare time, right? 03:44:38 brucer: hardly 03:44:52 :-) 03:44:54 in my spare time i'm more 'sit on the couch and watch movies developer' 03:45:04 ok, i think we've covered the important stuff 03:45:10 yep 03:45:11 OK! 03:45:20 thanks y'all, helpful 03:45:21 thanks everyone! o/ 03:45:22 oh wait! 03:45:25 one more thing 03:45:27 * loquacities hangs 03:45:35 we should have a new sphinx template that indicates incubation status 03:45:41 that'll probably happen this week or next 03:45:56 so incubating teams can build with oslosphinx but use an option to add an incubating indicator 03:45:59 that's all! 03:46:06 #link https://review.openstack.org/#/c/103349/ 03:46:10 great, something to keep me up all night 03:46:11 heh, neat 03:46:22 nice 03:46:22 if you are fascinated with that read up :) 03:46:32 thanks! 03:46:51 easy, thanks everyone 03:46:54 see y'all sometime in the future 03:46:54 #endmeeting