samccann commented 2 years ago

This agenda is old. The new agenda for 2023 is at https://github.com/ansible/community/issues/678

samccann commented 1 year ago

2022-10-04

Action Item updates:

resolved weekly staging of Ansible 7 and core 2.14 docs available on test
open - Consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings
open add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.

docs open hrs on matrix

proposal is to add another informal docs open hour to the WG meeting list for people wanting to discuss or drop in wit hquestions/help on actual words-on-paper docs things
:+1: will start Open Docs hours on Thursdays, 10AM ET

announcement

welcoming dnaro to the Ansible community engineering team!!!

Documentation updates

24 issues closed so far for hacktoberfest. Busy times!
Ansible 7 alpha staged at http://docs.testing.ansible.com/ansible/latest/index.html
ansible-core beta staged at - http://docs.testing.ansible.com/ansible-core/2.14/

sidecar docs

sidecar docs are intended for filter/test/non-python modules

doctools

parameter values enhancement to discuss - https://github.com/ansible-community/community-topics/issues/143

Actions

[ ] @samccann dnaro - create calendar entry to get the open docs hours on the WG calendar
[x] @samccann to open issues on impacted collections for filter/test plugin docs

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-10-04/documentation_working_group_aka_dawgs.2022-10-04-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-10-04/documentation_working_group_aka_dawgs.2022-10-04-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-10-04/documentation_working_group_aka_dawgs.2022-10-04-15.01.log.html

felixfontein commented 1 year ago

[x] https://github.com/ansible-community/antsibull-docs/pull/49

samccann commented 1 year ago

2022-10-18

Action Item updates:

resolved open issues on impacted collections for filter/test plugins - https://github.com/ansible-community/community-team/issues/65
open - Consider an 'open docs hr' later in the week to regularly interact with docs contributors in a friendlier way than the expert details that happen in DaWGs meetings
open add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.

Documentation updates

34 issues closed so far for hacktoberfest. Busy times!
ansible-core beta staged at - http://docs.testing.ansible.com/ansible-core/2.14/
https://github.com/ansible/ansible/issues/78082 I think we can close this one now

Doc Tools

Actions

[ ] @Don Naro to create docs open office hrs on Thursdays for EMEA timezone

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-10-18/documentation_working_group_aka_dawgs.2022-10-18-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-10-18/documentation_working_group_aka_dawgs.2022-10-18-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-10-18/documentation_working_group_aka_dawgs.2022-10-18-15.01.log.html

samccann commented 1 year ago

2022-10-25

Action Item updates:

in progress - setting up open hours for docs for EMEA
open add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.

Documentation updates

https://www.surveymonkey.com/r/NKTKV6W
survey is to find a day of the week and time for DaWGS EMEA docs open hour. a chance for contributors and interested parties to hang out more informally and just talk docs and writing.
https://www.surveymonkey.com/r/NKTKV6W
Ansible 7 alpha 2 should be out soon and will stage at http://docs.testing.ansible.com/ansible/7/index.html and http://docs.testing.ansible.com/ansible-core/2.14/
archiving 2.3 docs ready for merging. Redirects (with most module redirects removed for pastebin size limits) at https://pastebin.com/Hs7dBVSu
Reminder on new project tracking board for Ansible docs- https://github.com/orgs/ansible/projects/94
Help on issues always welcome :-)

doctools

https://github.com/ansible-community/antsibull-docs/blob/main/CHANGELOG.rst#v170 basically, though quite a few entries there have no relevance for the docs build

Open Floor

we keep Ansible devel docs tied to CI requirements for 'stability' while ansible-core devel have open requirements where we can detect problems for most things

Actions

[x] @samccann to test https://github.com/ansible/ansible/pull/79071 and verify we can merge/backport for 2.14

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-10-25/documentation_working_group_aka_dawgs.2022-10-25-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-10-25/documentation_working_group_aka_dawgs.2022-10-25-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-10-25/documentation_working_group_aka_dawgs.2022-10-25-15.01.log.html

samccann commented 1 year ago

2022-11-01

Action Item updates

Resolved -samcann to test https://github.com/ansible/ansible/pull/79071 and request backport to core 2.14
open - samccann add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.
open - dnaro to create docs open office hrs for EMEA timezone and add to WG calendar

doctools updates

ansible-core 2.14 rc2 staged at - http://docs.testing.ansible.com/ansible-core/2.14/
Ansible 7 alpha 2 staged at http://docs.testing.ansible.com/ansible/7/index.html
some problems with bad version labels - https://docs.ansible.com/ansible-core/2.14/collections/ansible/builtin/git_module.html#
https://docs.ansible.com/ansible-core/devel/collections/ansible/builtin/add_host_module.html#ansible-collections-ansible-builtin-add-host-module
we have a bug in antsibull-docs where it's mislabeling old stuff as `added in ansible-core 0.1 etc - 5 lookups, 1 connection plugin and 26 modules
:+1: we will keep antsibull-docs at 1.7.1 and fix/enhance how version added info is displayed in an update in devel only
felix will create a bugfix (1.7.2) for the ansible-core 0.7 problem but we won't add to stable-2.14 unless there are complaints about it

Documentation updates

Hactoberfest results - closed 36 issues, including boolean changes! Up from 26 issues last year.
archiving 2.3 docs ready for merging. Redirects (with most module redirects removed for pastebin size limits) at https://pastebin.com/Hs7dBVSu

What's next?

EMEA Office Hours survey. there's still only one response so far. what I'm thinking about doing is trying to ping the room on certain days to see who's around to talk docs, etc.
our current list of docs priorities -https://github.com/ansible-community/community-topics/issues/81

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-11-01/documentation_working_group_aka_dawgs.2022-11-01-15.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-11-01/documentation_working_group_aka_dawgs.2022-11-01-15.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-11-01/documentation_working_group_aka_dawgs.2022-11-01-15.00.log.html

samccann commented 1 year ago

2022-11-08

Action Item updates:

open - dnaro to create docs open office hrs for EMEA timezone and add to WG calendar
open add a link to a separate intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.

Meeting time

:+1: - shift the meeting to 1 hr later

Documentation updates

ansible-core 2.14 released along with its docs
Looking for thoughts on where we should target docs improvements next?
https://github.com/ansible-community/community-topics/issues/81 to add your ideas.

doctools

antisbull-docs fixes include action group module attribute, Ansible 0.x fixes.
proposal - use semantic versioning and allow sanity test to be fixed at current (1.7.1) but allow docs build to use 1.7.2, 1.7.3 etc but not 1.8.x
Ansible SDK API reference is empty when built with RTD
https://ansible-sdk.readthedocs.io/en/latest/api/ansible_sdk.html
https://github.com/ansible/ansible-sdk/blob/main/.readthedocs.yaml
https://docs.readthedocs.io/en/stable/config-file/v2.html#build

Actions

[x] @samccann - shift the meeting time in the calendar and remindbot
[x] @samccann to discuss antsibull-doc bugfix releases and can we update in stable-2.14 w/o updating CI containers.

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-11-08/documentation_working_group_aka_dawgs.2022-11-08-15.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-11-08/documentation_working_group_aka_dawgs.2022-11-08-15.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-11-08/documentation_working_group_aka_dawgs.2022-11-08-15.01.log.html

samccann commented 1 year ago

2022-11-15

Action Item updates:

Resolved - add an intro to the agenda for welcome/here's what you need to know/ etc so newcomers can prepare.
resolved - to discuss antsibull-doc bugfix releases and can we update in stable-2.14 w/o updating CI containers.
open - samccann shift meeting time in calendar and remindbot to 1 hr later

Documentation updates

Ansible 7 rc1 is out today. staging at http://docs.testing.ansible.com/ansible/7/index.html
archiving 2.4 next.

What's Next

Looking for thoughts on where we should target docs improvements next?
https://github.com/ansible-community/community-topics/issues/81 to add your ideas.
personas fit into 3 broad categories - content user (mostly awx) content creators (playbooks, roles, etc) and content developers ( writing plugins, contributing code etc)
https://github.com/ansible/ansible/pull/79244 < briantist fixing that
https://github.com/ansible/ansible/compare/devel...bcoca:ansible:controller_argspec looking for 'lanaguage' for docs for 'required_X' and other rules that now do not make it for docs but are in argspec

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-11-15/documentation_working_group_aka_dawgs.2022-11-15-16.01.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-11-15/documentation_working_group_aka_dawgs.2022-11-15-16.01.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-11-15/documentation_working_group_aka_dawgs.2022-11-15-16.01.log.html

samccann commented 1 year ago

2022-11-22

Documentation updates

Archived 2.4 docs. Will set up redirects next week.

What's next?

https://github.com/ansible-community/community-topics/issues/81 to add your ideas.

doctools

we can do patch updates to antsibull-docs in devel and stable-2.14 w/o updating the CI containers if we are okay with that drift.

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-11-22/documentation_working_group_aka_dawgs.2022-11-22-16.00.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-11-22/documentation_working_group_aka_dawgs.2022-11-22-16.00.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-11-22/documentation_working_group_aka_dawgs.2022-11-22-16.00.log.html

samccann commented 1 year ago

2022-11-29

Improve environment variable handling

https://github.com/ansible-community/antsibull-docs/pull/73
https://github.com/bcoca/ansible/tree/controller_argspec trick question, it wqas branch

Documentation updates

Ansible 7 released last week w/ docs!
Archived 2.4 docs - redirects are live now.

Open Floor

the plan is to make the ansible/docsite repo, which has the html fragements for docs.ansible.com, public
https://github.com/ansible/ansible/pull/79221#issuecomment-1329363454 for a direct link

Actions

[x] @samccann open ansible theme request to change :envvar: output to blue so it is obvioius that it's a hotlink
[ ] @open ansible/ansible docs issue to add links to the new collection envvar index page after the next antsibull-docs release

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2022-11-29/documentation_working_group_aka_dawgs.2022-11-29-16.02.html Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2022-11-29/documentation_working_group_aka_dawgs.2022-11-29-16.02.txt Log: https://meetbot.fedoraproject.org/ansible-docs/2022-11-29/documentation_working_group_aka_dawgs.2022-11-29-16.02.log.html

felixfontein commented 1 year ago

samccann commented 1 year ago

Dec 6 2022 Meeting Minutes

Action Items

closed - @samccann opened ansible theme request to change :envvar: output to blue so it is obvioius that it's a hotlink - and Felixfontein created PR to do this already!
closed - samccann shift meeting reminder with remindbot
open ansible/ansible docs issue to add links to the new collection envvar index page after the next antsibull-docs release

Personas

goal is to evaluate who the people are in our larger Ansible community, and how best to serve them with targeted docs and journies through our projects etc https://hackmd.io/KJInEFJmRfWsFGBGxEzviw?view

some background on personas and why they are helpful - https://www.usability.gov/how-to-and-tools/methods/personas.html

doctools

We should push for community maintainers added to the sphinx-ansible-theme, capable of creating a release etc.

Action Items

[ ] oraNod - to look into getting community maintainer(s) for the sphinx ansible theme
[ ] samccann flesh out the personas by completing the todo items and putting them in a detailed slidedeck that describes each.

samccann commented 1 year ago

Dec 12 2022 Meeting Minutes

Action item updates

open - oraNod - to look into getting community maintainer(s) for the sphinx ansible theme

open - samccann flesh out the personas by completing the todo items and putting them in a detailed slidedeck that describes each.

Documentation updates

Looking for feedback on how to open up the docs publishing pipeline - https://github.com/ansible-community/community-topics/issues/174
- must document how this works as well as have logging/tracking of who or what published the docs and when.
Also looking for feedback/ideas on user experience improvements for the Ansible docsite - https://github.com/ansible-community/community-topics/issues/175
site search still lacking. Many people avoid it because the results they want show up on page 2 or later. Need facets. And a full docs.ansible.com site search.
need more step by step content. End to end tutorial from ansible -m ping to a butch of stuff like tags, strategies, changed_when and failed_when
Can revamp/modernize this self-annotated playbook example and include links to the docs from each item - https://github.com/phred/ansible-examples/blob/master/pedantically_commented_playbook.yml

Action Items

[ ] samccann to ask about options for a persona-based doc survey
[ ] samccann to ask on user channel - what sorts of items get asked about time and again that we could answer in docs
[ ] oranod - to share the community-topics for docs in the user, community, and dev channels for feedback

mccann to ask on user channel - what sorts of items get asked about time and again that we could answer in docs

samccann commented 1 year ago

Agenda - 2023-Jan 3

Welcome!!

This meeting is open to everyone. We discuss topics related to Ansible project documentation and the tooling that publishes that documentation to docs.ansible.com. While the meeting at times goes deeply into some topics, we welcome newcomers and new contributors and are always willing to explain what we are discussing to help you follow along on the topics.

We currently focus on the Ansible package and ansible-core releases, tracking the docs issues and PRs.

Documentation work

[ ] review any docs-based action items from last week ongoing work:
[ ] proposing we archive docs for EOL releases - see https://github.com/ansible-community/community-topics/issues/78
[ ] examples repo - call for examples! https://github.com/ansible-community/community-examples/
[ ] New documentation issues and requests for help and the easyfix issues
- [ ] moving more collection scenario guides. see community.general for it in action!
[ ] Pending docs PRs that need help
- [ ] Docs survey feedback issues - https://github.com/ansible/ansible/issues?q=is%3Aissue+is%3Aopen+survey (6)

Docs tooling (antsibull etc)

[ ] Action Item review
[ ] archiving old EOL docs
[ ] docs boolean override to yes/no - https://github.com/ansible-community/community-topics/issues/116
[ ] Updates on ongoing work:
- [ ] rendering docs in a collection PR (briantist's work) - https://github.com/ansible-community/github-docs-build and wiki - https://github.com/ansible-community/github-docs-build/wiki

Open Floor

felixfontein commented 1 year ago

[x] https://github.com/ansible-community/antsibull-docs/pull/90

ansible / community

DaWGs (Documentation Working Group) Meeting Agenda 2022 #643

2022-10-04

Action Item updates:

docs open hrs on matrix

announcement

Documentation updates

sidecar docs

doctools

Actions

Logs

2022-10-18

Action Item updates:

Documentation updates

Doc Tools

Actions

Logs

2022-10-25

Action Item updates:

Documentation updates

doctools

Open Floor

Actions

Logs

2022-11-01

Action Item updates

doctools updates

Documentation updates

What's next?

Logs

2022-11-08

Action Item updates:

Meeting time

Documentation updates

doctools

Actions

Logs

2022-11-15

Action Item updates:

Documentation updates

What's Next

Logs

2022-11-22

Documentation updates

What's next?

doctools

Logs

2022-11-29

Improve environment variable handling

Documentation updates

Open Floor

Actions

Logs

Dec 6 2022 Meeting Minutes

Action Items

Personas

doctools

Action Items

Dec 12 2022 Meeting Minutes

Action item updates

Documentation updates

Action Items

Agenda - 2023-Jan 3

Documentation work

Docs tooling (antsibull etc)

Open Floor