Monday, 2019-10-28

*** ricolin has joined #openstack-sdks01:25
*** Dinesh_Bhor has quit IRC02:10
*** Dinesh_Bhor has joined #openstack-sdks03:32
*** ttsiouts has joined #openstack-sdks04:51
*** ttsiouts has quit IRC05:00
*** ttsiouts has joined #openstack-sdks05:39
*** ttsiouts has quit IRC05:59
*** factor has joined #openstack-sdks06:05
*** ttsiouts has joined #openstack-sdks06:19
*** Luzi has joined #openstack-sdks06:22
*** ttsiouts has quit IRC06:28
*** gtema has joined #openstack-sdks07:10
*** slaweq has joined #openstack-sdks07:12
*** gkadam has joined #openstack-sdks07:19
*** gkadam has quit IRC07:19
*** factor has quit IRC07:49
*** factor has joined #openstack-sdks07:50
*** ttsiouts has joined #openstack-sdks07:52
*** gtema has quit IRC07:53
*** factor has quit IRC07:56
*** factor has joined #openstack-sdks07:56
*** tosky has joined #openstack-sdks08:03
*** tkajinam has quit IRC08:04
*** lifeless has joined #openstack-sdks08:05
*** jpena|off is now known as jpena08:05
*** gtema has joined #openstack-sdks08:06
*** gtema has quit IRC08:11
*** ttx has left #openstack-sdks08:15
*** gtema has joined #openstack-sdks08:17
*** ttsiouts has quit IRC08:42
openstackgerritDmitry Tantsur proposed openstack/openstacksdk master: CI: add ironic-python-agent-builder to the ironic job
dtantsurmordred: ^^08:43
*** ttsiouts has joined #openstack-sdks08:43
*** cdent has joined #openstack-sdks08:47
*** ttsiouts has quit IRC08:48
*** ttsiouts has joined #openstack-sdks08:57
*** gtema has quit IRC09:03
*** gtema has joined #openstack-sdks09:04
*** jangutter has joined #openstack-sdks09:04
*** gtema has quit IRC09:04
*** gtema has joined #openstack-sdks09:06
*** gtema has quit IRC09:39
*** dustinc is now known as dustinc_pto10:07
openstackgerritShogo Saito proposed openstack/openstacksdk master: Adding basic implementation for Accelerator(Cyborg)
*** adriant has quit IRC10:23
*** adriant has joined #openstack-sdks10:25
*** adriant has quit IRC10:27
*** gtema has joined #openstack-sdks10:31
openstackgerritRiccardo Pittau proposed openstack/openstacksdk master: Add reset_interfaces argument to patch_node
*** tosky_ has joined #openstack-sdks11:08
*** tosky has quit IRC11:12
*** tosky_ is now known as tosky11:18
*** jangutter has quit IRC11:24
*** jangutter has joined #openstack-sdks11:43
*** ttsiouts has quit IRC12:04
*** ttsiouts has joined #openstack-sdks12:17
*** enriquetaso has joined #openstack-sdks12:19
*** jangutter has quit IRC12:43
*** jpena is now known as jpena|lunch12:49
*** gtema has quit IRC12:59
*** mriedem has joined #openstack-sdks13:16
*** ttsiouts has quit IRC13:18
*** gtema has joined #openstack-sdks13:27
*** ttsiouts has joined #openstack-sdks13:32
*** gtema has quit IRC13:41
*** gtema has joined #openstack-sdks13:43
*** goldyfruit_ has joined #openstack-sdks13:45
*** dtantsur is now known as dtantsur|brb13:57
*** jpena|lunch is now known as jpena14:08
openstackgerritRiccardo Pittau proposed openstack/openstacksdk master: Add reset_interfaces argument to patch_node
openstackgerritRiccardo Pittau proposed openstack/openstacksdk master: Increase dogpile version for Py3.7 compatibility
*** jdwidari has joined #openstack-sdks14:19
*** KeithMnemonic has joined #openstack-sdks14:21
*** goldyfruit___ has joined #openstack-sdks14:24
*** goldyfruit_ has quit IRC14:27
*** Luzi has quit IRC14:41
*** KeithMnemonic1 has joined #openstack-sdks14:55
*** KeithMnemonic1 has quit IRC14:56
*** KeithMnemonic1 has joined #openstack-sdks14:56
*** KeithMnemonic has quit IRC14:58
openstackgerritMarc Gariépy (mgariepy) proposed openstack/python-openstackclient master: [DOC]Fix openstack command for removing router
*** dtantsur|brb is now known as dtantsur15:03
*** ttsiouts has quit IRC15:55
*** ttsiouts has joined #openstack-sdks15:56
*** gtema has quit IRC15:59
*** enriquetaso has quit IRC16:03
*** enriquetaso has joined #openstack-sdks16:06
efrieddtroyer: So as I'm working through these plugin docs issues, it has been in the back of my head:16:18
efriedShould the plugin projects build osc in a gate job, so they don't break it?16:18
efriedor maybe they already do, /me looks...16:18
efriedah, I guess that's what openstackclient-plugin-jobs would be for?  ...16:20
efriedugh, that guy doesn't require novaclient or osc-placement.16:22
efriedalso, it doesn't appear to build docs, which would be a useful add.16:22
efried...and it's marked as non-voting by default.16:22
efried...and the only thing it does right now is check for duplicate entry points.16:27
efriedokay, so tldr some of the infrastructure is there, but it hasn't really been fleshed out.16:27
dtroyerefried: exactly.  that was all supposed to come together in the openstackclient repo and never did16:28
dtroyerIIRC stevemar was organizing all of that when IBM lured him to the dark side…16:28
efrieddtroyer: those IBM guys...16:29
efrieddtroyer: so what's next here?16:29
efriedlike, if I want to do a thing (like make sure python-xclient doesn't break python-openstackclient's doc build with a bogus option help) it would be nice if I didn't have to drag that entire openstackclient infra effort into daylight first.16:30
dtroyerefried: I think the cross-project plugin stuff still belongs in openstackclient, its purpose is to provide that integration for users, makes sense for the knowledge of plugins to all be there.16:30
efriedput another way: I'd like to be able to contribute without signing up for fixing the world.16:30
dtroyerexactly, which is why I'm not insisting that it be moved before improving what we do have16:30
dtroyerjust keep that in mind so we don't break that possibility somehow16:31
efriedokay, so...16:31
efriedI'm not actually going to be able to use that openstackclient job, since that project isn't building plugin docs yet16:32
efriedso I would need to need to create a new job in python-openstackclient16:32
efried...that installs all the plugins and builds its docs.16:32
efriedI guess I'll ask you: of those two alternatives, which seems like the path of least resistance?16:33
dtroyerI don't really like that either…  and this is all one reason I wasn't involved in it in the first place, I didn't want osc to be an integration bottleneck16:33
efriedmm, especially if the goal is to add $job to each of the 20+ plugin client projects, it would be better for it to be the real, long-term-plan job.16:34
efrieddtroyer: so was the eventual goal to somehow have the osc doc build moved from python-openstackclient to openstackclient?16:35
dtroyerif there is a lot to build, let's just do it in the final place.16:36
dtroyerThere was never a final goal to have a single doc, maybe a single index pointing to the individual ones, but the OSc dosc themselves should only cover what is in the repo16:36
dtroyerthe whole point of plugins was supposed to be freedom (for OSC) from having to gatekeep any of this16:37
efriednot sure I agree with that from a UX standpoint.16:37
efriedI mean, I understand from a project management perspective.16:37
efriedbut as a consumer of the docs, I would like to be able to navigate around the plugin docs without having to use the browser's Back button liberally.16:38
efriedGuess that's not the end of the world.16:38
dtroyerwhen there is less than a single half-time person maintaining something, this is what you get.  If someone has the time to build an integrated all plugins-and-everything doc, go for it.  I don't have that luxury any more.16:38
efriedwell, that's what I've done.16:38
* dtroyer glares at that pile of 3rd party CI waiting in the corner16:38
*** ttsiouts has quit IRC16:39
efried <== all of these links point to in-repo (python-openstackclient) docs built via autoprogram-cliff of the registered entrypoints of the plugins.16:39
dtroyerok, cool. I'll suggest that openstacklcient is the right repo for osc+plugins stuff,16:40
dtroyeryup, that was intended to be moved16:40
efried(all but the last five, which just need which is waiting for three final u-c bumps)16:40
efriedAnd should the rest of the python-openstackclient documentation also be moved?16:40
dtroyerno, unless you would do that for all of the plugins too.16:41
efriedsorry, "do that" what?16:41
dtroyermove all of their docs16:41
dtroyerpython-openstackclient as functioanlity and docs for that in one place16:41
efriedwell, the docs at $plugin are a separate thing.16:41
dtroyerand openstackclient is the integration point, not python-openstackclient16:41
dtroyerthis is such a mess because that transition was not completed and isn't a high enough priority (until now) for anyone to spend time on it16:42
dtroyerthis is life in a project that nobody really wants to pay for… "clients are not important" — a (former) OSF Platinum Board Member16:44
efriedokay, it's not a super high priority, I just came across it because I was trying to get at some plugin docs and couldn't find them in the first few obvious places I looked. What exists now is a dramatic improvement, but it's brittle.16:44
efriedBefore, $plugin could merge a broken option help and nobody would be the wiser16:45
efriedlike, literally nobody, because those weren't being used *anywhere* afaict.16:45
efriedNot even sure if they were being used to build the CLI helps. Maybe they were...16:45
efriedbut those obv don't have the same rules as the sphinx-built docs.16:45
efriedanyway, now if $plugin merges and releases a bogus option help, python-openstackclient will start to fail its doc build.16:46
efriedso it would be nice to prevent that rather than having to go fix it after the fact.16:46
efriedesp because the rate of change in python-openstackclient is so low, it could be ages before anyone even notices the breakage.16:46
dtroyeragain, this is why I did not want to be in the integration business16:47
dtroyerat least not in the python-openstackclient repo16:47
*** ricolin has quit IRC16:48
efriedcan you just bear with me a little bit longer and help me understand what the ideal utopian future state of this openstackclient repo would be?16:48
efriedand then I'll just take the ball and run it wherever I think will get us closer, if probably not actually all the way there.16:49
*** jpena is now known as jpena|off16:50
dtroyersure: anything and everything that should be handled across all (self-identified) plugins and OSC itself should happen there… docs, co-installability testing, whatever.  Even registering their existence.  Definition of the jobs so plugins (and OSC) can run the jobs to do the checking as those projects decide they care.  This is meant to be opt-in, as I don't enforce the OSC command structure standards on plugins (I lost that argument too), we'll t16:50
openstackgerritRiccardo Pittau proposed openstack/openstacksdk master: Add reset_interfaces argument to patch_node
efrieddtroyer: before I go asking the docs folks, any idea why openstackclient docs aren't being published? I see a doc/ dir with appropriate requirements, config, and an index.rst; and the .zuul.yaml lists the build-openstack-docs-pti template17:06
dtroyerefried: it may have never been set up, that repo wasn't really used until I released OSC 4 a couple of months ago17:07
*** dtantsur is now known as dtantsur|afk17:21
openstackgerritEric Fried proposed openstack/openstackclient master: Update doc index links (for storyboard etc)
efrieddtroyer: I'm gonna see if this builds docs at least in zuul. If it does, I think I'm going to copy all (or most?) of the docs from python-openstackclient into it. Then I can beef up that zuul job to build docs as well as do that dup check. Then I can start spraying that job into all the plugin projects.17:38
efriedeven if the docs never get published, that job running in zuul will allow us to gate and detect future option help breakages.17:39
dtroyerefried: ok, thanks for spending time on this17:40
efriedeventually if the docs do get published, we can stuff redirects in python-openstackclient, but we would probably still want *some* of the docs available there, so I'm not going to get real excited about that yet. Problem for future-us.17:40
efried...seems to have worked fine17:43
efriedokay, it's not publishing because it's using the build-...-pti job, not the publish-...-pti job.17:50
efried...which actually could be useful for our purposes here. Means I could make the docs build gate plugin projects without actually having to worry about whether the docs are pretty or correct.17:50
efrieddtroyer: that said, if you *do* want to start publishing those, it would be trivial at this point. Do you want me to pull that trigger?17:51
*** cdent has quit IRC18:20
openstackgerritMerged openstack/openstacksdk master: Switch to Ussuri jobs
*** icarusfactor has joined #openstack-sdks18:42
*** factor has quit IRC18:45
*** openstackgerrit has quit IRC18:50
*** mordred has quit IRC18:52
dtroyerefried: I'm not sure I want to publish docs outside of where they are maintained.  ie, a single consolidated doc requires someone to curate it and I'm not signing up for that.  I understand the ux sux but adding anything beyond pointers to the individual pieces eventually makes a worse experience when it gets stale19:26
dtroyerI've always found bad docs more frustrating than no docs FWIW19:27
efrieddtroyer: that's not really the question at the moment.19:27
dtroyerthan I'm misunderstanding it19:27
efriedMaybe I misunderstood, but I thought the eventual goal was to maintain the osc docs in the openstackclient project, not python-openstackclient.19:27
efriedthis would be a step in that direction, though not getting us all the way there yet.19:28
efrieddo you mean maintaining docs outside of where the corresponding code is maintained?19:28
dtroyerno, the OSC docs belong with the code, just like the plugin docs19:28
dtroyera unified guide of some sort would be great, but that's what we don't have the capacity to do, very similar to the overall docs efforts19:28
efriedokay, so here's my current strategy:19:31
efried- Copy the python-openstackclient docs to the openstackclient project. Keep the build-...-pti, don't publish yet.19:31
efried- Beef up the openstackclient-plugin-jobs template to include building those docs ^.19:31
efried- Make sure all the plugin projects gate on openstack-plugin-jobs. This prevents them from merging patches with broken option helps.19:31
dtroyerI don't want to move docs from python-openstackclient to openstackclient19:32
dtroyerunless they are bits talking about the entire collection of things.  leave the individual command stuff with the commands19:33
efriedThe next (future, I'm not planning on doing this any time soon) steps would be:19:33
efried- Scrub the docs in both projects to keep the appropriate ones in the appropriate project. Add redirects from any python-openstackclient ones we remove. (No redirects from openstackclient are necessary because never published.)19:33
efried- Start publishing openstackclient docs.19:33
efriedbut for now the easiest thing to achieve the goal (which is being able to prevent broken plugin docs from merging) is to do a full copy.19:34
dtroyercan you do it the same way you do the plugins today?  I don't think you are planning to copy those docs too, right?19:34
efriedThat's exactly what I'm doing, albeit with a slightly bigger hammer.19:35
dtroyerok, when you say copy, I read check-in, is that incorrect?19:35
efriedI could pick and choose which docs to copy over, to achieve the sole goal of preventing the breakages, but that would be harder and the resulting docs would be not necessarily cohesive (not that that really matters at this stage).19:35
efriedI meancp -r python-openstackclient/doc/source openstackclient/doc/source19:36
efriedgit add -A19:36
efriedgit commit19:36
dtroyeryou are doing that with all plugins too?19:36
efriedthe plugin "docs" that are part of python-openstackclient are just a couple dozen pages with one autoprogram-cliff line in them. That automatically sucks in the docs from the respective projects.19:37
efriedso those are coming along, in the same referential-y way.19:37
efriedproduces this
dtroyerit seems like way overkill to just copy it all only to filter it someday.  having two copies out there _will_ confuse someone even if we don't publish it19:40
dtroyerif you fix zuul for me I'll copy the structure over tonight…19:41
efried"the structure"?19:42
efriedand "fix zuul"?19:42
efriedIf you strongly prefer not to have two copies, I can make a hacked-up page that's hidden from view that just does the auto doc generation stuff. It would still build (and thus break if plugins f'ed up their opt helps) but we would have no duplication.19:44
*** openstackgerrit has joined #openstack-sdks19:57
openstackgerritMerged openstack/openstacksdk master: CI: add ironic-python-agent-builder to the ironic job
*** enriquetaso has quit IRC20:12
openstackgerritEric Fried proposed openstack/python-openstackclient master: Use autoprogram-cliff for remaining plugin docs
openstackgerritEric Fried proposed openstack/openstackclient master: Copy in python-openstackclient docs
openstackgerritEric Fried proposed openstack/openstackclient master: Add docs build to openstackclient-plugin-jobs template
*** goldyfruit___ has quit IRC20:39
*** mordred has joined #openstack-sdks20:43
*** jdwidari has quit IRC20:44
openstackgerritEric Fried proposed openstack/openstackclient master: Copy in python-openstackclient docs
openstackgerritEric Fried proposed openstack/openstackclient master: Add docs build to openstackclient-plugin-jobs template
*** goldyfruit___ has joined #openstack-sdks20:47
*** tosky has quit IRC20:53
efrieddtroyer: Update:21:00
efried- those reqs bumps merged, so this patch ought to be ready for review (python-openstackclient, autodocs the last five plugins):
efried- I pushed up the openstackclient series above, which21:00
efried  - updates the index
efried  - copies over all the docs from python-openstackclient
efried  - tries to make the openstack-plugin-jobs template build docs (but I did it way wrong, need to rework)
*** umbSublime has quit IRC21:01
efriedoh, and trying to do autoprogram-cliff:: openstack doesn't work. It needs to match the entry point exactly.21:02
efriedthe granularity is accomplished via that :command: syntax - but is optional.21:02
*** goldyfruit___ has quit IRC21:26
*** adriant has joined #openstack-sdks21:57
*** slaweq has quit IRC22:06
*** KeithMnemonic1 has quit IRC22:06
openstackgerritEric Fried proposed openstack/python-openstackclient master: WIP: neutron: autogenerate docs
efrieddtroyer: FYI, I'm at least starting to go through and replace hardcoded content with autogen ^22:31
*** slaweq has joined #openstack-sdks22:36
*** slaweq has quit IRC22:40
*** goldyfruit___ has joined #openstack-sdks22:42
*** mriedem has quit IRC23:13
*** adriant has quit IRC23:25
*** adriant has joined #openstack-sdks23:25
*** slaweq has joined #openstack-sdks23:46
*** slaweq has quit IRC23:51

Generated by 2.15.3 by Marius Gedminas - find it at!