19:00:30 #startmeeting docteam 19:00:32 Meeting started Wed Jun 8 19:00:30 2016 UTC and is due to finish in 60 minutes. The chair is annegentle. Information about MeetBot at http://wiki.debian.org/MeetBot. 19:00:33 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 19:00:35 The meeting name has been set to 'docteam' 19:00:37 o/ 19:00:43 heya 19:00:45 o/ 19:00:52 Agenda is rolling and is here 19:00:53 o/ 19:00:54 o/ (on behalf of keystone) 19:00:54 #link https://wiki.openstack.org/wiki/Meetings/DocTeamMeeting#Agenda_for_next_meeting 19:00:57 hello 19:01:00 cool lbragstad 19:01:01 now at the correct time 19:01:11 #topic Action items from the last meeting 19:01:18 o/ (magnum) 19:01:29 I looked through the minutes for this timezone and didn't see any outstanding action items. 19:01:35 <- neutron-ish 19:01:48 So I think we can move along to the next topic 19:01:56 #topic Specs in review 19:02:06 Looks like one spec for training labs 19:02:14 #link https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z 19:02:30 HI all! I am around.. 19:02:33 Updated end of May, any questions? Any specs to-be-written or discussed? 19:02:38 hey emagana all around 19:03:21 we have enough to do with existing content and specs ;) 19:03:26 annegentle: i'm working on a networking guide reorg, but its not really worthy of a spec (imo) 19:03:39 less overhead = more betterer 19:03:44 Sam-I-Am: Then it's not a real reorg ;) 19:03:47 Sam-I-Am AJaeger yeah, I think what we have in play is good enough 19:04:00 AJaeger: hmmmmmmmmm :) 19:04:20 there's also tracking of newton ongoing at https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables 19:04:52 though Sam-I-Am no mention of Networking reorg there so might wanna get it on the radar screens 19:04:53 Sam-I-Am: I do agree. WE can do the work without the formal spec 19:05:04 annegentle: +1 19:05:07 :-) 19:05:13 let's get to specialty teams then 19:05:16 #topic Speciality teams 19:05:27 annegentle: it sort of came up as more content has appeared in the guide, which i figured it would at some point 19:05:38 Sam-I-Am yeah organic growth happens 19:05:43 #link https://etherpad.openstack.org/p/Speciality_Team_Reports 19:05:49 Let's go down the list in that report's order 19:05:59 anyone here for HA Guide? 19:06:03 #topic HA Guide 19:06:19 #info no report from HA Guide team 19:06:27 #topic Install Guide 19:06:39 We have a name! 19:06:39 Poll concluded, winner is "OpenStack Installation Tutorial" 19:06:43 #info Poll concluded, winner is "OpenStack Installation Tutorial" 19:06:47 There's a patch for heat: 19:06:59 ohh linky 19:07:14 and one for project-config to set up infrastructure: https://review.openstack.org/326039 19:07:23 heat: https://review.openstack.org/325389 19:07:34 and manila: https://review.openstack.org/#/c/317152/ 19:07:34 Thanks 19:07:39 So, we're moving forward with migration to project teams! 19:07:41 #link http://eavesdrop.openstack.org/#Documentation_Install_Team_Meeting 19:07:46 great, strigazi 19:07:48 Excellent thanks strigazi 19:07:59 I work on magnum thow 19:08:00 #link https://review.openstack.org/325389 19:08:07 #link https://review.openstack.org/#/c/317152/ 19:08:17 AJaeger: What do you mean with project teams? 19:08:23 strigazi heh that's good though 19:08:34 Hi, btw. :D 19:08:41 rcaballeromx1 hiya! 19:08:44 #link http://specs.openstack.org/openstack/docs-specs/specs/newton/installguide.html 19:09:03 rcaballeromx1 that spec outlines how to scale the Installation Tutorial across project teams 19:09:15 project team = heat, manila, trove, etc. 19:09:17 rcaballeromx1: I mean that the install guides moves into the projects 19:09:22 rcaballeromx1 does that help? 19:09:34 Thanks annegentle & AJaeger. 19:09:37 It does. 19:09:40 cool 19:09:41 ok 19:09:47 #topic Networking Guide 19:09:53 Sam-I-Am and emagana go for it, what's up? 19:09:53 so... 19:10:08 we're finally seeing a decent number of contribs to the networking guide 19:10:08 annegentle: Sam-I-Am already mentioned some of the staff going on 19:10:20 problem is, they're all ending up in 'advanced config' 19:10:33 which is misleading, and potentially a mental stumbling block for many potential users 19:10:44 also working on moving staff from other guides into the networking one in order to keep a better control and have those sections updated all the time as much as possible 19:10:49 #link http://eavesdrop.openstack.org/#Networking_Guide_Team_Meeting is the weekly IRC meeting 19:11:01 Let's rename it to "less advanced config" or something better ;) 19:11:06 there are also new features that one might consider experimental, or too light on detailed docs 19:11:06 annegentle: Yes! 19:11:15 custom config? 19:11:18 Sam-I-Am good to have the advanced from those who know... long tail of contributions. 19:11:32 so i'm doing a bit of a reorg that puts all config things under 'config' and experimental-ish things under 'experimental' 19:11:45 "you try it and see and let us know!" 19:11:46 non-standard if you want to discourage use of those configs. 19:11:59 that's pretty cool though, kudos 19:12:11 that and trying to make the naming a bit more eppo-ish 19:12:28 like something called config-bgp doesnt just provide config, it explains what it is and also happens to provide config 19:12:35 emagana when you said Moved DHCP HA chapter to Networking Guide -- from where? 19:12:49 so then it just becomes bgp.rst, and where its linked to determines the category 19:13:16 also trying to do a bit better integration of the scenarios 19:13:31 from the adin guide 19:13:34 its nice when you have content that gives you a better idea of how it should be organized 19:13:35 admin* 19:13:47 already completed: https://review.openstack.org/#/c/323660/ 19:13:49 prior to this was sort of a guess on structure 19:14:08 annegentle: Now I am working on updates 19:14:09 #info Networking Guide sections moving, renaming, additional explanation. Moved DHCP HA content from Admin Guide to Networking Guide 19:14:31 i'm also bugging neutron folks to fill out some of the weaker content 19:14:39 emagana Sam-I-Am you want an info line or help line in the notes for meeting attendance or any particular sections? 19:15:04 always good to mention our meeting 19:15:18 as for contributions, the etherpad is the source 19:15:21 #info Looking for attendees at weekly networking guide IRC meeting, join in 19:15:33 Sam-I-Am oh, link here to that ether pad too 19:15:34 annegentle: Yes, in general we would like to increase the attendance but we know its hard 19:15:47 #link https://etherpad.openstack.org/p/networking-guide 19:15:51 good deal 19:15:54 anything else on Networking? 19:16:02 thats a general list of topics we're looking to fill out 19:16:03 #topic Security Guide 19:16:04 annegentle: not from my siede! 19:16:12 Do we have anyone from the security team? 19:16:25 I can't remember Nathaniel Dillon's IRC handle. hrm 19:16:35 #info no report from Security Guide 19:16:47 #topic User Guides 19:17:12 IA plan still forthcoming, unless I missed it on the ML. 19:17:33 Had some nice input on the SDK pages 19:17:47 though those aren't yet architected for a final landing spot :) 19:17:52 I'll await the IA 19:18:01 IA? 19:18:03 Anything else on user guides? Did the magnum team have input there? 19:18:12 IA=Information Architecture (what goes where) 19:18:20 Thanks. 19:18:39 sure. basically the spec originally had the SDK info moving to developer.openstack.org rather than docs.openstack.org 19:18:48 anything else on user guides? 19:19:03 * annegentle #topic Ops Guide 19:19:12 Since Shilla's in training I don't know if anyone else has an update? 19:19:35 #info no report from Ops Guide team 19:19:44 #topic API Guides 19:19:47 I'll take that 19:20:11 We should be able to delete the Compute API content from api-site, on the review I'm looking for whether we do redirects in that patch or in another 19:20:29 #link https://review.openstack.org/#/c/306884/ 19:20:38 Also, check out nice new styling 19:20:45 #link https://review.openstack.org/#/c/322430/ 19:20:46 and 19:21:03 #link https://api.os.gra.ham.ie/compute/ 19:21:40 Really looking nice and neat. We're still figuring out a cross-project-api navigation bar but this aligns more with the modern web design. 19:21:45 Kudos to Graham 19:22:03 #info New layout for API reference docs from additions to openstackdocs theme. 19:22:21 #info Much gratitude to Graham Hayes! 19:22:28 +1 19:22:31 +2 19:22:38 #info Discussion on SDKs and FirstApp audience happening on user-committee list 19:22:46 #link http://lists.openstack.org/pipermail/user-committee/2016-May/000889.html 19:23:03 I'm not one of the authors on the First App, so I'd like input on that list from some of the original authors. 19:23:16 mmm, that api layout is nice 19:23:19 #info Seeking input on FirstApp audience from original authors 19:23:27 Sam-I-Am pretty responsive too 19:23:34 Sam-I-Am and the tables don't suck 19:23:39 Who are the original authors? 19:23:59 rcaballeromx1 Tom Fifield, Sean Collins, Christian Berendt 19:24:10 Thanks! 19:24:23 * annegentle #link http://developer.openstack.org/firstapp-libcloud/ 19:24:41 Oh, and James Dempsey too 19:24:48 #link http://www.openstack.org/blog/2015/07/writing-your-first-openstack-application/ 19:24:53 That's all from API landia. 19:25:04 #topic Config/CLI Reference 19:25:36 #info Tomoyuki reported they are closing bugs in Mitaka, including fixes to RST markup. 19:25:43 Nice work. 19:25:53 yeah, there's plenty of config ref things in the queue 19:26:00 i spent half my day in it yesterday 19:26:06 #info Lots to review for config ref 19:26:12 Sam-I-Am good to know 19:26:15 they're mostly small and easy 19:26:22 #topic Training labs 19:26:39 Pranav or Roger around? 19:26:48 rluethi or dguitarbite (iirc) 19:27:13 #info Spec for pxeserver in review, also updating the training labs landing page 19:27:21 That's what I know from reading. 19:27:27 #topic Training guides 19:27:41 Do we have Matjaz? It might be late for him 19:27:56 #info Working on upstream training updates 19:28:04 That's all I know from reading there too 19:28:13 #topic Hypervisor Tuning Guide 19:28:41 Haven't seen updates for a while on that one. 19:28:45 yeah, me neither 19:28:51 seems like vapor :/ 19:28:53 #info no info on Hypervisor Tuning Guide 19:29:03 #topic UX/UI Guidelines 19:29:11 Let's see anyone for UX here? 19:29:24 I uploaded something for UX 19:29:24 Looks like by this Friday a draft for the guidelines will be ready 19:29:32 UX Personas. 19:29:35 rcaballeromx1 cool, have a link I can post for the notes? 19:29:51 #link https://review.openstack.org/#/c/326662/7 19:30:06 thanks rcaballeromx1 19:30:26 My pleasure. 19:30:41 Lots of review comments, nice. 19:31:07 Okay I'll wrap up specialty team reports then 19:31:22 #link https://etherpad.openstack.org/p/Speciality_Team_Reports 19:31:33 #info Specialy teams, use that etherpad to fill in weekly status updates 19:31:41 #topic Countdown to release 19:31:48 #link http://www.timeanddate.com/countdown/launch?iso=20161006T00&p0=1440&msg=OpenStack+Newton+Launch+Date&font=slab 19:32:07 119 days means less than four months right? 19:32:10 yet another release... 19:32:17 give or take 19:32:19 #link https://wiki.openstack.org/wiki/Documentation/NewtonDeliverables 19:32:20 By a day. 19:32:46 ^^ that's the scope of the docs work for Newton to the best of my knowledge 19:32:56 oh no, a wiki :) 19:33:04 docs task 1 - get rid of wiki :) 19:33:10 Though also the specs 19:33:29 #link http://specs.openstack.org/openstack/docs-specs/ 19:33:30 the networking guide isnt in there. do we need to put things there? 19:33:47 Sam-I-Am I'm not entirely sure, ask loquacities on the ML the intent with that. 19:33:52 nothing super critical going on, just trying to make it better 19:33:58 yeah 19:33:59 Is the Config Reference Guide not a Newton deliverable? 19:34:29 rcaballeromx1 it is, I think that wiki page needs an update :) 19:34:43 and the networking guide is versioned, so I imagine it should go on there too 19:34:45 annegentle: Ok. 19:34:52 Ok, opening it up 19:34:55 we need to version more things :/ 19:34:57 #topic Open discussion 19:35:25 there was some discussion at the summit about versioning more stuff, and keeping certain things around longer 19:35:29 did that ever get anywhere? 19:36:12 bueller? 19:36:22 Sam-I-Am I only know about the networking guide versioning. And then we also talked about adding a version menu to say Client doc pages. 19:36:35 I guess I get to introduce myself. I am a Sr. tech. writer at Intel and will be helping out where I can. Starting with the UX-Personas. 19:36:38 python-projectclient for example 19:36:46 rcaballeromx1 awesome thanks for the intro 19:36:49 I'm based in sunny Guadalajara, Mexico. 19:37:03 rcaballeromx1 sweet! Are you with Marcela's team? 19:37:09 annegentle: net guide versioning was done last release 19:37:23 welcome, rcaballeromx1 ! And sorry for my quick reviews without a friendly welcome to your first patch! 19:37:41 rcaballeromx1 AJaeger is super fast on the review button :) 19:37:41 annegentle: No, but I will be working with them. 19:37:46 things like the admin guide might be useful to version 19:37:47 one more "paisano" in the team! welcome rcaballeromx1 19:38:15 AJaeger: No problem, next time you can put them in German, I did live 15 years in Germany. :D 19:38:19 emagana hehe I had to look that up even though I live in Tejas :) 19:38:25 rcaballeromx1: ;) 19:38:48 annegentle: ;-) 19:39:20 I am working on a governance patch to try to get a handle on what projects have which docs. 19:39:35 #link https://review.openstack.org/#/c/316396/ 19:39:39 governance, exciting, I know. 19:39:42 :) 19:39:52 feel free to post ideas... still a work in progress 19:40:20 The other patch in progress is to try to figure out which projects provide a REST API and therefore should have API docs 19:40:22 #link https://review.openstack.org/#/c/317094/ 19:40:28 hmmm interesting 19:40:45 what we need is something makes devs contribute docs :) 19:40:54 what I've discovered is that per-repo isn't quite right nor is per-project... 19:40:59 Is the api content pulled from the projects' code bases? 19:41:17 rcaballeromx1 yes, as of this release, some is ongoing migration this release. 19:41:37 So that won't be the case in the future? 19:41:39 annegentle: does that sort of thing need a... "operatordocs" or "userdocs" tag? 19:41:42 rcaballeromx1 used to be in a central api-site repo. 19:41:54 so people know there's a clear delineation between dev docs and not-dev docs? 19:42:07 Sam-I-Am yeah, the idea is to add on in categories 19:42:16 annegentle: are there instructions for creating API-docs 19:42:28 annegentle: fetching out patch... 19:42:30 Sam-I-Am yaml might be better represented with say docs: - contributordocs - apidocs - installdocs and so on 19:42:33 maybe docs: contributor: xxx user: xxx or somesuch 19:42:35 strigazi sure 19:42:40 strigazi: That was going to be my next question. 19:42:49 annegentle: https://review.openstack.org/#/c/317368/ 19:42:52 strigazi you have this right 19:42:52 yeah, yaml in irc is hard 19:42:54 #link http://docs.openstack.org/contributor-guide/api-guides.html 19:43:06 but i think we were thinking the same thing 19:43:26 strigazi ah, thanks,hadn't seen that one yet 19:43:38 annegentle: Is there something similar for Configs? 19:43:57 rcaballeromx1 thinking 19:43:57 annegentle: do you want me to comment on that patch? 19:44:17 Sam-I-Am: magnum's patch? 19:44:27 rcaballeromx1 start with http://docs.openstack.org/contributor-guide/tools-and-content-overview.html 19:44:30 strigazi: the governance patch 19:44:38 Sam-I-Am: ok 19:44:40 Sam-I-Am sure on the governance patch 19:44:47 annegentle: Thanks. 19:44:52 strigazi anything you need on the magnum patch? 19:45:06 strigazi I will say I still want web design for the connecting navigation between project's API docs 19:46:16 strigazi nice to see progress made though. 19:46:21 ok, anything else? 19:46:30 annegentle: I don't have the right questions yet :) 19:46:31 busiest docs meeting in a looooong time 19:46:39 I'm happy to end early if we're all good 19:46:45 strigazi yeah, understandable :) 19:46:59 strigazi I can answer questions as you go 19:47:07 Okie doke thanks all for being here 19:47:10 #endmeeting