Notification time stamped 2020-05-19 16:04:48 UTC
===========================================
#ansible-docs: Docs Working Group aka DaWGs
===========================================
Meeting started by acozine at 14:31:10 UTC. The full logs are available
at
https://meetbot.fedoraproject.org/ansible-docs/2020-05-19/docs_working_gr...
.
Meeting summary
---------------
* docs pipeline update (acozine, 14:33:22)
* ansible-doc can't solve what the docs pipeline needs so developing a
separate parser with a docs schema. See
https://gist.github.com/abadger/5d7ad556052758993b3245f9dc14a1d9 for
work thus far (samccann, 14:36:05)
* this is using pydantic for the schema. fyi docs sanity test uses
volumptuous (samccann, 14:38:10)
* json schema from this may be helpful in the future for developing
stricter testing on the module docs. (samccann, 14:42:33)
* this approach would mean we no longer use ansible-doc --json to
output docstrings for module/plugin docs (samccann, 14:53:40)
* ACTION: abadger1999 to archive ansible-doc cards in the project
board (samccann, 14:55:49)
* ACTION: samccann to create a 2.11 column for evaluating next steps
with this approach (aka integrating the schema json into
ansible-test for docs, passing the approach on to AH to consider
etc) (samccann, 14:56:46)
*
https://github.com/ansible/ansible/pull/69268 (acozine, 14:59:29)
* version_added in collections (acozine, 15:00:58)
* LINK:
https://github.com/ansible/ansible/pull/69291 (felixfontein,
15:01:18)
* LINK:
https://github.com/ansible/ansible/pull/69291 (samccann,
15:01:49)
* problem occurs when a collection includes a doc_fragment from
ansible-base. The collection has version_added for collection
version, while doc_fragment reflects ansible-base version
(samccann, 15:05:31)
* LINK:
https://github.com/ansible/ansible/pull/69291#issuecomment-630409820
contains examples of how this looks with ansible-doc (felixfontein,
15:06:57)
* collections will use version_added to reflect collection version.
ansible-base use it to reflect ansible-base version. The PR then
parses to add 'built in' vs 'collection' to the version number to
clarify for users. (and tests collection version # ) (samccann,
15:11:43)
* ACTION: samccann to add card to docs pipeline board for future work
- consider whether we need version too old back again (samccann,
15:16:08)
* specify --collection-version_added for ansible-test sanity to
enforce new options get version_added set correclty (samccann,
15:22:03)
* how optional should the optional test be and can we turn on the
version_added test on ansible-base withought messing up other
optional tests? (samccann, 15:56:32)
* open floor (acozine, 16:03:07)
Meeting ended at 16:04:48 UTC.
Action Items
------------
* abadger1999 to archive ansible-doc cards in the project board
* samccann to create a 2.11 column for evaluating next steps with this
approach (aka integrating the schema json into ansible-test for docs,
passing the approach on to AH to consider etc)
* samccann to add card to docs pipeline board for future work - consider
whether we need version too old back again
Action Items, by person
-----------------------
* abadger1999
* abadger1999 to archive ansible-doc cards in the project board
* samccann
* samccann to create a 2.11 column for evaluating next steps with this
approach (aka integrating the schema json into ansible-test for
docs, passing the approach on to AH to consider etc)
* samccann to add card to docs pipeline board for future work -
consider whether we need version too old back again
* **UNASSIGNED**
* (none)
People Present (lines said)
---------------------------
* felixfontein (131)
* acozine (80)
* samccann (51)
* abadger1999 (42)
* mattclay (33)
* zodbot (8)
* jtanner (3)
* cbudz_ (2)
Generated by `MeetBot`_ 0.1.4
.. _`MeetBot`:
http://wiki.debian.org/MeetBot
https://meetbot.fedoraproject.org/ansible-docs/2020-05-19/docs_working_gr...
--
You received this message due to your preference settings at
https://apps.fedoraproject.org/notifications/fmnmeetingminutes.id.fedorap...