19:02:53 #startmeeting docteam 19:02:54 Meeting started Wed Aug 17 19:02:53 2016 UTC and is due to finish in 60 minutes. The chair is Sam-I-Am. Information about MeetBot at http://wiki.debian.org/MeetBot. 19:02:55 Useful Commands: #action #agreed #help #info #idea #link #topic #startvote. 19:02:57 The meeting name has been set to 'docteam' 19:03:00 guess we'll get this thing rolling 19:04:02 Sam-I-Am sorry, can't today 19:04:11 ok 19:05:34 annegentle: well, you had two action items 19:05:41 so if you can fill us in on those, that's good 19:05:55 #topic action items from last meeting 19:06:11 annegentle will post to the dev mailing list regarding status code standardization 19:06:14 annegentle to add file renaming to newton deliverables 19:07:06 ok, guess not 19:07:09 Sam-I-Am both done 19:07:17 annegentle: thanks 19:07:22 #topic specs in review 19:07:34 #link https://review.openstack.org/#/q/status:open+project:openstack/docs-specs,n,z 19:07:38 i dont have much to add here 19:07:52 I will have something by next week's meeting. 19:08:13 in specs? 19:08:32 Yes. 19:08:44 But it is not there yet. 19:09:11 any preview rcaballeromx ? :) 19:09:30 It is an expansion on the personas. 19:09:41 ok, so we'll see that at some point 19:09:42 Including how they affect interface development. 19:09:48 With examples! 19:09:51 :D 19:09:56 rcaballeromx ok, thanks 19:10:00 annegentle looking for your note to -dev on the status code standardization. Do you remember when you happen to send that? 19:10:35 lbragstad sorry, I realized I sent that giant status update and read only status not status code. After talking to mugsie after the meeting, I proposed a patch. 19:10:39 lbragstad let me find it 19:11:12 #link https://review.openstack.org/#/c/351835/ 19:11:32 #link https://review.openstack.org/#/c/351794/ 19:11:43 lbragstad until those land I wasn't going to email the -dev list 19:11:56 annegentle gotcha - thanks 19:12:07 i brought it to the keystone group last week and we has some questions 19:12:24 lbragstad ok we can go over it during the api specialty topic 19:12:31 annegentle cool 19:12:31 in that case... 19:12:38 #topic specialty teams 19:12:42 api.. go. 19:12:53 first alphabetically too! 19:13:05 hello everyone! sorry I'm late, i had another meeting that ran late 19:13:09 #info Anne patching the os-api-ref repo with example HTTP status codes 19:13:12 hey ShillaSaebi :) 19:13:20 Anne thank you for chairing!! 19:13:25 it's been one of those days... 19:13:30 except i'm chairing... 19:13:30 it's Sam-I-Am who can do it! :) 19:13:34 oh thank you Matt! 19:13:41 anyway, continue... 19:13:45 lbragstad carry on kind sir 19:13:59 annegentle i brought this https://review.openstack.org/#/c/349551/1 up to the keystone meeting last week 19:14:15 and we were looking through the examples and were curious who the intended audience was for the document? 19:14:34 would this be considered developer documentation? 19:14:36 lbragstad content published to developer.openstack.org is intended for app developers 19:14:40 ok 19:14:53 lbragstad contributor developers also, of course. but primary app devs, consumers of the services 19:15:07 is the intent to give app developers a place to go when certain things go wrong, or they get unexpected error codes? 19:15:09 lbragstad so that was why I was leaning away from "informal" 19:15:14 lbragstad yep 19:15:27 lbragstad hence my "uh let's not poke the bear" on the informal 19:15:51 annegentle gotcha - in keystone's case we mask a lot of things with a 401 19:16:05 lbragstad yeah you do have the chance to give specfiic info on that. if you have it. 19:16:25 lbragstad instead of "informal" you'd use something more like "blah-blah-401" 19:16:39 lbragstad like line 4 of https://review.openstack.org/#/c/349551/1/api-ref/source/v2/http-codes.yaml 19:17:00 lbragstad because they know more about that when it happens on a particular resource, they can sub in image-data-200 19:17:04 lbragstad in the inc file 19:17:39 so - would it be accurate to say this seems to be the inverse document of something like? http://developer.openstack.org/api-ref/identity/v3/index.html#authentication-and-token-management 19:18:02 where you have the request your making and all the possible response codes? 19:18:13 lbragstad you can keep with that bulleted list thing if you like. But we're giving you the option of "A required attribute was missing." when you know that's what 401 means in a particular case every time. 19:19:12 lbragstad the idea is "add a pointer to more precise descriptions for each code" 19:19:26 lbragstad and also gives nice table formatting 19:19:28 ah 19:19:42 lbragstad your generic one is ok 19:20:02 so - what's being proposed isn't exactly a *new* document but one that can enhance what we already have if we choose to use it? 19:21:09 lbragstad it's a more-parallel option 19:21:20 lbragstad parameters.yaml and status.yaml maintenance 19:21:31 lbragstad right, it's a new tool 19:21:47 new feature in the os-api-ref tool 19:21:56 * annegentle gets precise with words 19:22:06 words have meaning 19:22:16 dat's right 19:22:27 +1 19:22:31 lbragstad you'd be a good reviewer on both those patches 19:22:51 lbragstad comment on clarifying when to use it, perhaps 19:23:10 annegentle sounds good - i guess the biggest thing the keystone folks were wondering is if it would duplicate doc efforts? 19:23:30 * rcaballeromx will take a look as well. 19:23:30 lbragstad the idea behind the example yaml is that it would give teams a good starting point 19:23:32 maybe the way i relayed the message made it seem like a reverse lookup of traditional api docs 19:23:47 lbragstad then it's all consistent messages, and teams can further clarify as needed 19:23:56 lbragstad basically trying to make it easier for teams 19:24:05 25 APIs and all that 19:24:10 sure 19:24:36 thanks rcaballeromx 19:25:00 anything else for api? 19:25:17 no problem annegentle 19:25:39 Sam-I-Am that's it. 19:25:43 ok 19:25:44 * annegentle has to head out early 19:25:48 thanks 19:25:49 thanks Sam-I-Am ShillaSaebi 19:25:56 thanks annegentle have a good one! 19:26:17 networking guide... i'm trying to backport the reorg patch which involves another patch to add redirects 19:26:24 so - i'll bring this all back to the keystone group and see if it clears up some of the confusion we had 19:26:30 lbragstad thanks 19:26:39 annegentle thanks for the explanation :) 19:26:49 while that's in the queue, i'm reorganizing the deployment scenarios to use building blocks rather than more or less repeating a LOT of information 19:26:59 start simple, get more complex is the theme 19:27:08 cool 19:27:21 its a lot of work, but hopefully it ends well 19:28:05 fingers crossed 19:28:35 +1 19:28:55 yep 19:28:58 thats it for networking 19:29:02 install guide 19:29:25 this is about when i'd expect to see config updates for newton, but i havent seen any 19:29:35 but its not my project 19:29:43 any other specialty team reports? 19:29:58 ops/arch guide update: ops guide reorg in progress 19:30:11 i've seen some of those patches go by 19:30:14 working on getting some more enterprise docs added into the ops guide 19:30:24 the rabbit MQ troubleshooting one was the start of it 19:30:44 those would make sense 19:31:03 i'm still on the idea we should consolidate our books to make things easier to find 19:31:07 but thats another topic... 19:31:14 Arch Guide working group proposed a series of short sprints and working in pairs as SMEs...Dates TBD 19:31:18 yeah i don't disagree with you there 19:31:32 eventually 19:31:44 i've been trying, but its not gaining a lot of traction 19:31:53 everything in one place, organized by service 19:32:11 yeah I can see that 19:32:18 that's all I got really on the ops/arch guide 19:32:23 maybe a spec for O :) 19:32:29 yeah maybe :) 19:32:36 ok. any other specialty groups? 19:33:13 #topic #open discussion 19:33:15 oops 19:33:18 #topic open discussion 19:33:25 anything else? 19:33:30 are u going to be in NY? 19:33:37 for either OpenStack East or the mid cycle? 19:33:52 i'm going to the ops mid 19:34:03 and apparently moderating the docs session 19:34:11 nice! 19:34:21 ill be at openstack east but not the mid cycle 19:35:01 * rcaballeromx is sad to miss it. 19:35:01 doh. they're close, arent they? 19:35:17 yeah i think openstack east is Tues/Wed and midcycle is Thurs/Friday? 19:35:21 both in NY 19:35:25 something like that 19:35:42 ok 19:35:44 well i don't have anything else 19:35:53 me neither 19:35:55 sorry i was late! 19:35:57 i think we're done 19:36:05 have a good one and talk to you all later! 19:36:16 #endmeeting