docs_working_group
LOGS
15:30:56 <samccann> #startmeeting Docs Working Group
15:30:56 <zodbot> Meeting started Tue Jan 15 15:30:56 2019 UTC.
15:30:56 <zodbot> This meeting is logged and archived in a public location.
15:30:56 <zodbot> The chair is samccann. Information about MeetBot at http://wiki.debian.org/MeetBot.
15:30:56 <zodbot> Useful Commands: #action #agreed #halp #info #idea #link #topic.
15:30:56 <zodbot> The meeting name has been set to 'docs_working_group'
15:31:10 <samccann> hello!!  Anyone around today?
15:32:32 <bcoca> no
15:32:55 <samccann> heh quite possibly!
15:32:57 <Pilou> o/
15:33:24 <samccann> hi Pilou !
15:34:34 <Pilou> about #50278: differences between role vars and role params should be documented :)
15:34:52 <samccann> #chairs Pilou
15:35:02 <samccann> hmm maybe it's singular...
15:35:03 <Pilou> and should not role params be used in the documentation (instead of role vars) ?
15:35:04 <samccann> #chairs
15:35:10 <samccann> #chair
15:35:10 <zodbot> Current chairs: samccann
15:35:19 <samccann> #chair Pilou
15:35:19 <zodbot> Current chairs: Pilou samccann
15:35:40 <samccann> #topic Role vars vs role params
15:37:01 <samccann> #link https://github.com/ansible/ansible/issues/50278
15:37:09 <samccann> sorry took me a bit to find it
15:37:35 <Pilou> before #37844, role params were used. Because "name" can be used as a role parameter, i am not sure to understand why this was changed ?
15:38:33 <samccann> I don't know if there are enough people around this am to provide context here
15:41:48 <samccann> i'm thinking there aren't enough people around to have this meeting today. if no one pipes in in the next couple of minutes, I'll end it.  Sorry Pilou
15:43:38 * gundalow waves
15:43:42 <Pilou> np :)
15:43:54 <gundalow> Other meeting has just finished, appologies for the delay
15:44:03 <samccann> np
15:44:09 <samccann> #chair gundalow
15:44:09 <zodbot> Current chairs: Pilou gundalow samccann
15:44:28 <samccann> any clues on Pilou's question?
15:44:36 * gundalow reads 50278
15:45:07 <gundalow> Whatever the answer we needs docs and tests added to defend the "correct" behaviour
15:47:39 <samccann> so it's currently a coding bug. We can watch it for whatever ends up the resolution and append a doc PR to it once the issue is addressed
15:47:53 <gundalow> samccann: yup, that makes sense to me
15:48:45 <Pilou> I might be a coding bug,
15:49:33 <samccann> yeah I added a comment to say we need to document whatever results from this.  the triage label was removed a few days ago, so hopefully someone is taking a look
15:49:47 <Pilou> but the main point is that "role params" differs from "role vars" and that seems unexpected because not documented
15:50:09 <samccann> #info there will be a documentation change needed based on issue #50278 (once it is resolved)
15:50:58 <samccann> but if it is a bug of some sort, do we change documentation now, or wait for the bug to be fixed?
15:51:41 <Pilou> i mean: the special behavior mentioned here https://github.com/ansible/ansible/issues/50278#issuecomment-450927689 is a small thing compared to "role params" vs "role vars"
15:52:55 <samccann> ok I don't really follow the differences, but are you suggesting there is a separate doc issue that needs to be documented regardless of that potential code bug?
15:53:26 <Pilou> yep
15:54:14 <Pilou> the 2nd bullet point in summary of the issue
15:56:13 <bcoca> actually i believe that is a bug
15:56:29 <bcoca> if set in vars: it should not persist across role invocations
15:56:34 <samccann> #chair bcoca
15:56:34 <zodbot> Current chairs: Pilou bcoca gundalow samccann
15:56:45 <bcoca> so i dont think we need to document, but fix the issue
15:58:09 <Pilou> you mean that "role vars" should be the same than "role params" ?
16:01:20 <bcoca> no
16:01:30 <bcoca> role params would bleed, vars: should not
16:01:43 * bcoca really wants to kill role params ...
16:02:53 <samccann> so they are two different things, but perhaps the docs don't make that clear?
16:04:31 <bcoca> i dont think we've ever correctly documented role params
16:05:35 <Pilou> meanwhile a fix for this issue, should not the doc switch back to "role params" ?
16:05:41 <felixfontein> hi. sorry for being late!
16:09:44 <samccann> any thoughts on the current topic ' role params vs role vars?
16:10:11 <gundalow> hum, what's the `-` on https://docs.ansible.com/ansible/devel/modules/include_role_module.html between `apply` and `added in 2.7`?
16:10:54 <felixfontein> gundalow: that's the type
16:11:01 <felixfontein> which isn't specified
16:12:55 <felixfontein> (I think it's the result of https://github.com/ansible/ansible/pull/49966)
16:18:36 <samccann> ok not sure if we decided role param vs vars requires a doc update or not...
16:21:18 <Pilou> bcoca: could be switch back to "role params" in all examples and use "role vars" once this issue has been fixed ?
16:24:09 <Pilou> because current example with "vars" - for example the one with "foo_app_instance" called twice with different parameters - doesn't work as expected
16:27:16 <samccann> gundalow: do we ever put notes in documentation to say see issue XXX because things aren't working as expected yet?
16:31:34 <samccann> well, sorry folks... we've run out of time and I don't think we really resolved this discussion...
16:32:07 <samccann> #endmeeting