Closed samccann closed 1 year ago
antsibull sphinx-init
), it's not much more complicated: https://github.com/ansible-collections/community.hashi_vault/blob/main/.github/workflows/docs.ymlcommunity.hashi_vault
repo, but they should be moved to their own project(s) so that they can be treated as the separate projects they are_shared
): https://github.com/ansible-collections/community.hashi_vault/tree/main/.github/workflowsMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-01-04/documentation_working_group_aka_dawgs.2022-01-04-15.59.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-01-04/documentation_working_group_aka_dawgs.2022-01-04-15.59.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-01-04/documentation_working_group_aka_dawgs.2022-01-04-15.59.log.html
Listing still-open action items from 2021 so I don't have to look at the old issue anymore :-):
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-01-11/documentation_working_group_aka_dawgs.2022-01-11-16.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-01-11/documentation_working_group_aka_dawgs.2022-01-11-16.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-01-11/documentation_working_group_aka_dawgs.2022-01-11-16.00.log.html
community.docer
and community.hashi_vault
ansible-test --help1
outputMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-01-18/documentation_working_group_aka_dawgs.2022-01-18-16.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-01-18/documentation_working_group_aka_dawgs.2022-01-18-16.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-01-18/documentation_working_group_aka_dawgs.2022-01-18-16.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-01-25/documentation_working_group_aka_dawgs.2022-01-25-15.58.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-01-25/documentation_working_group_aka_dawgs.2022-01-25-15.58.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-01-25/documentation_working_group_aka_dawgs.2022-01-25-15.58.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-02-01/documentation_working_group_aka_dawgs.2022-02-01-16.04.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-02-01/documentation_working_group_aka_dawgs.2022-02-01-16.04.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-02-01/documentation_working_group_aka_dawgs.2022-02-01-16.04.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-02-08/documentation_working_group_aka_dawgs.2022-02-08-15.59.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-02-08/documentation_working_group_aka_dawgs.2022-02-08-15.59.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-02-08/documentation_working_group_aka_dawgs.2022-02-08-15.59.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-02-15/documentation_working_group_aka_dawgs.2022-02-15-15.59.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-02-15/documentation_working_group_aka_dawgs.2022-02-15-15.59.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-02-15/documentation_working_group_aka_dawgs.2022-02-15-15.59.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-02-22/documentation_working_group_aka_dawgs.2022-02-22-15.59.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-02-22/documentation_working_group_aka_dawgs.2022-02-22-15.59.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-02-22/documentation_working_group_aka_dawgs.2022-02-22-15.59.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-03-01/documentation_working_group_aka_dawgs.2022-03-01-15.59.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-03-01/documentation_working_group_aka_dawgs.2022-03-01-15.59.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-03-01/documentation_working_group_aka_dawgs.2022-03-01-15.59.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-03-08/documentation_working_group_aka_dawgs.2022-03-08-15.58.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-03-08/documentation_working_group_aka_dawgs.2022-03-08-15.58.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-03-08/documentation_working_group_aka_dawgs.2022-03-08-15.58.log.html
NOTE: we will switch the UTC time of this meeting once Daylight savings happens in Europe (March 27th) so that the meeting time remains constant throughout the year for those places using DST.
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-03-15/documentation_working_group_aka_dawgs.2022-03-15-16.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-03-15/documentation_working_group_aka_dawgs.2022-03-15-16.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-03-15/documentation_working_group_aka_dawgs.2022-03-15-16.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-03-29/documentation_working_group_aka_dawgs.2022-03-29-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-03-29/documentation_working_group_aka_dawgs.2022-03-29-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-03-29/documentation_working_group_aka_dawgs.2022-03-29-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-04-05/documentation_working_group_aka_dawgs.2022-04-05-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-04-05/documentation_working_group_aka_dawgs.2022-04-05-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-04-05/documentation_working_group_aka_dawgs.2022-04-05-15.01.log.html
known_good_reqs.txt
and using the code-smell requirements file instead - https://github.com/ansible/ansible/blob/devel/test/sanity/code-smell/docs-build.requirements.txtMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-04-19/documentation_working_group_aka_dawgs.2022-04-19-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-04-19/documentation_working_group_aka_dawgs.2022-04-19-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-04-19/documentation_working_group_aka_dawgs.2022-04-19-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-04-26/documentation_working_group_aka_dawgs.2022-04-26-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-04-26/documentation_working_group_aka_dawgs.2022-04-26-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-04-26/documentation_working_group_aka_dawgs.2022-04-26-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-05-03/documentation_working_group_aka_dawgs.2022-05-03-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-05-03/documentation_working_group_aka_dawgs.2022-05-03-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-05-03/documentation_working_group_aka_dawgs.2022-05-03-15.01.log.html
community.aws
is partially using the docs build work by briantistMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-05-10/documentation_working_group_aka_dawgs.2022-05-10-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-05-10/documentation_working_group_aka_dawgs.2022-05-10-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-05-10/documentation_working_group_aka_dawgs.2022-05-10-15.01.log.html
I'm not sure if I'll find the time to join your meeting, but I thought that ansible-community/community-topics#91 might be interesting for you to discuss.
I've already started with community.vmware
and the Guidelines for VMware module development are now available within the collection documentation.
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-05-17/documentation_working_group_aka_dawgs.2022-05-17-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-05-17/documentation_working_group_aka_dawgs.2022-05-17-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-05-17/documentation_working_group_aka_dawgs.2022-05-17-15.00.log.html
ongoing work:
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-05-24/documentation_working_group_aka_dawgs.2022-05-24-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-05-24/documentation_working_group_aka_dawgs.2022-05-24-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-05-24/documentation_working_group_aka_dawgs.2022-05-24-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-05-31/documentation_working_group_aka_dawgs.2022-05-31-15.02.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-05-31/documentation_working_group_aka_dawgs.2022-05-31-15.02.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-05-31/documentation_working_group_aka_dawgs.2022-05-31-15.02.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-06-07/documentation_working_group_aka_dawgs.2022-06-07-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-06-07/documentation_working_group_aka_dawgs.2022-06-07-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-06-07/documentation_working_group_aka_dawgs.2022-06-07-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-06-14/documentation_working_group_aka_dawgs.2022-06-14-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-06-14/documentation_working_group_aka_dawgs.2022-06-14-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-06-14/documentation_working_group_aka_dawgs.2022-06-14-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-06-21/documentation_working_group_aka_dawgs.2022-06-21-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-06-21/documentation_working_group_aka_dawgs.2022-06-21-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-06-21/documentation_working_group_aka_dawgs.2022-06-21-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-07-12/documentation_working_group_aka_dawgs.2022-07-12-15.02.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-07-12/documentation_working_group_aka_dawgs.2022-07-12-15.02.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-07-12/documentation_working_group_aka_dawgs.2022-07-12-15.02.log.html
We discussed this briefly during the last WWG (https://github.com/ansible/community/issues/644#issuecomment-1173906302) and I think there's consensus on that side for ansible.windows
being a more appropriate place than community.windows
. Any concerns with that from the docs side?
Docs build workflows have been enabled on community.windows
, and there's an open PR for that on ansible.windows
too (https://github.com/ansible-collections/ansible.windows/pull/388).
If the WWG and DaWGs folks all agree on a destination, I can put up a PR for making that guide part of one of the collections.
I will be AFK all day for the 7/12 UTC meeting but I will see comments on linked issues and can view the meeting minutes if necessary.
cc @nitzmahone @jborean93
@briantist
We discussed this briefly during the last WWG (#644 (comment)) and I think there's consensus on that side for
ansible.windows
being a more appropriate place thancommunity.windows
. Any concerns with that from the docs side?
I don't see myself as part of "the docs side", but I think the important thing is to move the Windows module development guide
out of ansible-core. If you prefer ansible.windows
over community.windows
, that should be OK.
cc @samccann
@briantist
We discussed this briefly during the last WWG (#644 (comment)) and I think there's consensus on that side for
ansible.windows
being a more appropriate place thancommunity.windows
. Any concerns with that from the docs side?I don't see myself as part of "the docs side", but I think the important thing is to move the
Windows module development guide
out of ansible-core. If you preferansible.windows
overcommunity.windows
, that should be OK.cc @samccann
@mariolenz
There was some brief chatting with @samccann in the channel today; personally I'm not sure it should even move out of core since much of the required machinery (from internals to module_utils [here, and here]) is still in core. But I think it's more up to core members to weigh in on that. If consensus is that it should move, then imo ansible.windows
makes more sense, but that's based mostly on it being "closer" to core.
It's also worth noting that Windows development is not limited to the two existing Windows collections (one of which has stopped accepting new content); developing Windows modules is on par with the development guide for Python modules (if we're moving that guide too, then I guess it's more consistent to move this one as well).
It's a bit of a tricky one. A lot of the docs in there are really collection agnostic and any collection can write Windows modules. As @briantist mentioned it references Ansible.Basic.cs
which is still a module util inside of the Ansible repo itself so we can technically run the risk of it not staying in sync. It's not the end of the world that it moves but it is technically generic info for Ansible rather than something specific to that collection.
I think the generic stuff, especially what's covering ansible-core's module_utils, should stay in the ansible-core repository. This should also be part of ansible-core's documentation. If there is anything specific to ansible.windows and/or community.windows, that should go into the collections (I didn't see anything though, but then I also didn't look very closely :) ).
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-07-19/documentation_working_group_aka_dawgs.2022-07-19-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-07-19/documentation_working_group_aka_dawgs.2022-07-19-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-07-19/documentation_working_group_aka_dawgs.2022-07-19-15.00.log.html
community.windows
and ansible.windows
) are now using the github-docs-build toolingand
ansible-doc --metadata-dump` or on the docsiteMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-07-26/documentation_working_group_aka_dawgs.2022-07-26-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-07-26/documentation_working_group_aka_dawgs.2022-07-26-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-07-26/documentation_working_group_aka_dawgs.2022-07-26-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-08-02/documentation_working_group_aka_dawgs.2022-08-02-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-08-02/documentation_working_group_aka_dawgs.2022-08-02-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-08-02/documentation_working_group_aka_dawgs.2022-08-02-15.01.log.html
Did something change with docs recently to make the version switcher no longer result in a new page navigation? When I change versions now, I can no longer use the browser back and forward buttons to get back to the version I was on. This is particularly bad for going to 2.9 docs where the version switcher disappears, so I have to edit the URL to go back to where I was.
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-08-09/documentation_working_group_aka_dawgs.2022-08-09-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-08-09/documentation_working_group_aka_dawgs.2022-08-09-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-08-09/documentation_working_group_aka_dawgs.2022-08-09-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-08-16/documentation_working_group_aka_dawgs.2022-08-16-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-08-16/documentation_working_group_aka_dawgs.2022-08-16-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-08-16/documentation_working_group_aka_dawgs.2022-08-16-15.00.log.html
antsibull-docs
>= 1.3 to get this locallyMinutes: https://meetbot.fedoraproject.org/ansible-docs/2022-08-23/documentation_working_group_aka_dawgs.2022-08-23-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-08-23/documentation_working_group_aka_dawgs.2022-08-23-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-08-23/documentation_working_group_aka_dawgs.2022-08-23-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-08-30/documentation_working_group_aka_dawgs.2022-08-30-15.02.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-08-30/documentation_working_group_aka_dawgs.2022-08-30-15.02.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-08-30/documentation_working_group_aka_dawgs.2022-08-30-15.02.log.html
I would like to get feedback on this idea I had about publishing my collection's changelog in the docsite, and whether we might want to consider first class support for it in the tooling (maybe an entry in links.yml
to control it), that would make it easier to opt-in and avoid the need for a symlink.
More info here:
Rendered example:
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-09-13/documentation_working_group_aka_dawgs.2022-09-13-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-09-13/documentation_working_group_aka_dawgs.2022-09-13-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-09-13/documentation_working_group_aka_dawgs.2022-09-13-15.01.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-09-20/documentation_working_group_aka_dawgs.2022-09-20-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-09-20/documentation_working_group_aka_dawgs.2022-09-20-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-09-20/documentation_working_group_aka_dawgs.2022-09-20-15.00.log.html
Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-09-27/documentation_working_group_aka_dawgs.2022-09-27-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-09-27/documentation_working_group_aka_dawgs.2022-09-27-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-09-27/documentation_working_group_aka_dawgs.2022-09-27-15.00.log.html
This agenda is old. The new agenda for 2023 is at https://github.com/ansible/community/issues/678