==================================================== #ansible-docs: Documentation Working Group aka DaWGs ==================================================== Meeting started by samccann at 15:00:14 UTC. The full logs are available at https://meetbot.fedoraproject.org/ansible-docs/2021-09-21/documentation_working_group_aka_dawgs.2021-09-21-15.00.log.html . Meeting summary --------------- * opening chatter (samccann, 15:00:27) * ACTION: samccann to get ariordan ops rights (samccann, 15:07:06) * still need to followup on CI testing with Sphinx 4 (samccann, 15:11:26) * still need to reword the intro to collection modules so they don't suggest a user has to install the collection (it's already in Ansible) (samccann, 15:12:00) * ACTION: samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text (samccann, 15:14:01) * core-2.12 docs needs (samccann, 15:15:56) * we are tracking 2.12 docs needs with https://github.com/ansible/ansible/issues/75664 (samccann, 15:16:08) * if you see anything missing, please add as a comment to that issue (samccann, 15:16:26) * new module atttributes (samccann, 15:16:48) * New module attributes (samccann, 15:17:07) * background - core supports displaying a batch of 13 or more attributes. See https://github.com/ansible/ansible/issues/75164 for the debate on the docs side (samccann, 15:17:52) * after much deliberation and resorting to a Higher Authority (tm) the decision is to display all the attributes. (samccann, 15:18:13) * we need to determine next if we can do this in a table or if it must be some kind of list. The problem is - each attribute can have 3-6 fields. (samccann, 15:18:47) * https://github.com/ansible/ansible/pull/75619 is the next step on this in core and still in flux. (samccann, 15:19:44) * also, from a usability perspective (mobile apps, etc) - tables are frowned upon (samccann, 15:22:11) * dev_guide/collections_galaxy_meta.rst has an example of how to add a CSS class in rst and also of using an rst list to output an html table (abadger1999, 15:27:50) * ACTION: samccann to mock up the attributes as a list (samccann, 15:29:01) * ssh doc problem (samccann, 15:30:29) * see https://github.com/ansible/ansible/pull/73708 (samccann, 15:30:35) * felixfontein merged a PR which prevents the error message (samccann, 15:33:46) * still needs additional work/PR to add the new info to the output for the ssh plugin (samccann, 15:35:11) * expand/collapse in sphinx (samccann, 15:37:17) * would be nice to have this capability so we can display the new attributes in collapsed state. (samccann, 15:37:47) * see https://github.com/ansible-community/antsibull/pull/303#issuecomment-918345118 (samccann, 15:38:10) * a test PR for this is at https://github.com/ansible/ansible/pull/75695 but has CI problems (samccann, 15:38:50) * LINK: https://github.com/ansible/ansible/blob/devel/test/sanity/code-smell/rstcheck.py could be rewritten to use rstcheck as a library, and then one can use the same code as in https://github.com/ansible-community/antsibull/pull/281 to teach it about that directive (felixfontein, 15:42:27) * we can extend irstcheck to ignore the new directives. (samccann, 15:44:11) * ACTION: samccann go read rst check docs for how to do this (samccann, 15:44:48) * Ansible 5 docs needs (samccann, 15:46:23) * Open Floor (samccann, 15:49:19) * LINK: https://github.com/ansible-collections/community.hashi_vault/issues/138 (briantist, 15:51:55) Meeting ended at 16:01:42 UTC. Action Items ------------ * samccann to get ariordan ops rights * samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text * samccann to mock up the attributes as a list * samccann go read rst check docs for how to do this Action Items, by person ----------------------- * ariordan * samccann to get ariordan ops rights * samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text * rights * samccann to get ariordan ops rights * samccann * samccann to get ariordan ops rights * samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text * samccann to mock up the attributes as a list * samccann go read rst check docs for how to do this * the * samccann to mock up the attributes as a list * to * samccann to get ariordan ops rights * samccann ariordan to create issue to update wording on antsibull for collection module boilerplate text * samccann to mock up the attributes as a list * samccann go read rst check docs for how to do this * **UNASSIGNED** * (none) People Present (lines said) --------------------------- * samccann (109) * felixfontein (47) * abadger1999 (20) * gwmngilfen-work (17) * zodbot (13) * acozine (10) * ariordan[m] (9) * briantist (7) * Toshio[m] (3) * ariordan (0) * ok (0) * so (0) * the (0) * only (0) * real (0) * problem (0) * was (0) * I'd (0) * asked (0) * to (0) * handle (0) * chairs (0) * and (0) * she (0) * doesn't (0) * have (0) * correct (0) * rights (0) * yet (0) * right? (0) Generated by `MeetBot`_ 0.3 .. _`MeetBot`: https://fedoraproject.org/wiki/Zodbot#Meeting_Functions