Skip to content
This repository has been archived by the owner on Jun 10, 2024. It is now read-only.

DaWGs (Documentation Working Group) Meeting Agenda 2021 #579

Closed
acozine opened this issue Dec 22, 2020 · 79 comments
Closed

DaWGs (Documentation Working Group) Meeting Agenda 2021 #579

acozine opened this issue Dec 22, 2020 · 79 comments
Labels
docs related to documentation meeting_agenda

Comments

@acozine
Copy link
Contributor

acozine commented Dec 22, 2020

Closing this issue. Please add agenda items to the new 2022 issue - #643

This tracks the DaWGs (Documentation Working Group )meetings for Ansible docs, starting from Jan. 2021.

This team uses the following GitHub tracking boards:

If you have a question, comment, idea, or anything else to discuss, please leave a comment here to add it to the agenda for our next meeting. If you don't show up for the meeting, your item will probably be skipped.

If your IRC nick is different from your Github username, leave that as well.

See https://github.com/ansible/community/blob/master/meetings/README.md for the schedule.

Once an item has been addressed please edit the text to make it strike-through style (two tildes ~~ on either side of the text) or check the checkbox if available.

When creating new agenda ensure docs and meeting_agenda labels are set.

Join us anytime in #ansible-docs on libera IRC!

See #521 for 2020 minutes and #389 for prior meeting minutes.

@acozine
Copy link
Contributor Author

acozine commented Dec 23, 2020

2021-01-05

long-running issues from

do we or don't we adopt semantic markup

open floor

  • if you have question, concern, or idea related to Ansible docs, you can bring it up in the ansible-docs channel at any time, or add it to the DaWGs meeting agenda by adding a comment to DaWGs (Documentation Working Group) Meeting Agenda 2021 #579
  • everyone is welcome in the channel and in all meetings
  • we will have the supplemental docs meeting on Thurs at 10:30ET to discuss/update on the docsite split

Actions

  • @acozine to create a WIP PR that illustrates proposed semantic markup, solicit feedback

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-05/docs_working_group_aka_dawgs.2021-01-05-16.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-05/docs_working_group_aka_dawgs.2021-01-05-16.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-05/docs_working_group_aka_dawgs.2021-01-05-16.00.log.html

@acozine
Copy link
Contributor Author

acozine commented Dec 23, 2020

Contributing to Ansible Documentation

Easy Places you can help!

Less easy but need developer help on:

interesting links

@acozine
Copy link
Contributor Author

acozine commented Dec 23, 2020

2021-01-07

status update

  • problem statement - the ansible PyPI package called version 3.0.0 will beta at start of Feb 2021 timeframe and some time after that, the ansible-core PyPI package called version 2.11 will release. We need a way for docs to reflect the two “streams” of versions. Ansible 3.0.0 docs need to reference back to ansible-base 2.10 docs for all Ansible features that are not collections.
  • proposal docs.ansible.com/ansible becomes Ansible the Package documentation. docs.ansible.com/ansible-core becomes the core only documentation.
  • current status Reviewing internally to get full buyin from management later this week
  • Today's meeting goals - implementation - assuming we get approval, how can we accomplish all this in 3 weeks and 2 days (to have a docsite for 3.0.0 beta)
  • agenda - DaWGs (Documentation Working Group) Meeting Agenda 2021 #579 (comment)

what must we accomplish by Feb 2 and what can we push off to a later

  • proposal https://hackmd.io/TQmzyhCUSSKa22iFR_079A?both
  • 👍 we need a docsite that reflects Ansible 3.0.0, that doesn't mess up older releases, and that has /devel/ for ansible-core
  • 👍 we will not try to unversion any existing docs (aka community/developer guide) by Feb 2.
  • https://docs.ansible.com/ansible/devel/roadmap/COLLECTIONS_3_0.html that seems to refer to 2.11
  • If a user installs Ansible 3.x it will never install ansible=core 2.11
  • Ansible 4.x would never install core-2.12 either
  • Docs will reflect what is in Ansible the package and not attempt to match what a user may manually upgrade after that

new repo for new community guides etc

Actions

  • @samccann abadger1999 to continue discussing how to build this 3.x docsite from some 2.10 rst files later today

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-07/documentation_working_group_supplemental_meeting.2021-01-07-15.31.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-07/documentation_working_group_supplemental_meeting.2021-01-07-15.31.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-07/documentation_working_group_supplemental_meeting.2021-01-07-15.31.log.html

notes on brainstorming session

https://hackmd.io/x0VwaKSYQCaHGJR4LelSEw?view

*dev guide *- people will need 2.10 info, some devel info, some will need both. this is a case that either a unified dev guide that includes the differences between older versions and newer versions or an index page with the different versions of various documents would attempt to solve.

  • contributor to ansible-core: needs devel info.
  • collection creator: probably needs both.
  • private module person: needs latest stable release
    Our best option is to attempt to create the unversioned dev guide out of /devel/ and go back in to mark what is new for 2.11 (or 3.x) based on commit/prs.

@samccann
Copy link
Contributor

samccann commented Jan 5, 2021

2021-01-12

role argspec update

  • decided to place the argspec in meta/main.yml under the argument_specs entry. that was to satisfy a request from felixfontein for future docs reasons.
  • we have no doc specific requirements spec'd for it at this time, but i would expect that to be filled out after the initial PoC phase.
  • 2.11 you can expect: 1) validates role args at task execution time from spec in meta/main.yml, 2) ansible-doc support to output role entrypoints and descriptions.
  • the role arg spec format will be a subset of module arg spec. they will, in fact, share the same code.
  • removing the "update on role argspec" from the agenda for the next few months, will add it back as a regular item after 2.11 release

template for collection /docs/ folder

  • directory: we're going to propose allocating a specific subdirectory in the collection for building docsite content from. Nothing unrelated to the docsite should be placed there.
  • need 'some way' to make labels unique across all the collections
  • an example of a potential label would be .. _anscoll_community_crypto_LABEL:: (anscoll_community_crypto is the part that uniquifies the label.
  • need a way to exclude collections whose docs are bad (for instance, contain conflicting labels) or include the collections that are known good.
  • https://github.com/sensu/sensu-go-ansible/blob/master/docs/Makefile.custom is what we do to render things.

docs user survey results

open floor

Actions

  • @tadeboro to investigate ways to move forward with role docs as we wait for role argspec validation
  • @acozine to summarize today's conversation in a proposal or issue

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-12/docs_working_group_aka_dawgs.2021-01-12-16.01.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-12/docs_working_group_aka_dawgs.2021-01-12-16.01.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-12/docs_working_group_aka_dawgs.2021-01-12-16.01.log.html

@samccann
Copy link
Contributor

samccann commented Jan 7, 2021

2021-01-14

Status of the docsite split proposal

problems to solve

list of problems to solve

Next Steps

  • 👍 we will stop having this extra meeting and fold updates/issues into the regular tuesday DaWGs meetings
  • acozine working on jenkins build samccann working on makefile lmodemal working on variable subsitution
  • abadger1999 investigating the antsibull side of this to see if it 'all works' or needs some changes
  • more information also available on the project board at https://github.com/ansible/ansible/projects/27

Actions

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-14/dawgs_aka_documentation_working_group_supplemental_meeting.2021-01-14-15.32.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-14/dawgs_aka_documentation_working_group_supplemental_meeting.2021-01-14-15.32.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-14/dawgs_aka_documentation_working_group_supplemental_meeting.2021-01-14-15.32.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Jan 9, 2021

@samccann
Copy link
Contributor

samccann commented Jan 12, 2021

2021-01-19

opening chatter

open floor

  • no more Thursday supplemental DaWGs meeting. We are implementing the docsite split now and will cover details in Tuesday meetings
  • docsite work is progressing. We will post here when we have test site updates available for review.

Actions

  • @dmsimard to backport PR that adds FQCN to glossary

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_aka_dawgs.2021-01-19-16.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_aka_dawgs.2021-01-19-16.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_aka_dawgs.2021-01-19-16.00.log.html

adding breadcrumbs to the plugin pages

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_meeting_extension.2021-01-19-16.55.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_meeting_extension.2021-01-19-16.55.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-19/docs_working_group_meeting_extension.2021-01-19-16.55.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Jan 18, 2021

@samccann
Copy link
Contributor

samccann commented Jan 19, 2021

2021-01-26

Docsite Split Update

documenting use of C(. . . )

open floor

Actions

  • @abadger1999 to figure out how to implement make webdocs ANSIBLE=2.10;; make webdocs ANSIBLE=3 ;; make coredocs and report back later this week
  • @acozine to clear the docs backports queue

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-01-26/documentation_working_group_aka_dawgs.2021-01-26-16.02.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-01-26/documentation_working_group_aka_dawgs.2021-01-26-16.02.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-01-26/documentation_working_group_aka_dawgs.2021-01-26-16.02.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Jan 20, 2021

@samccann
Copy link
Contributor

samccann commented Jan 26, 2021

2021-02-02

Index pages for the Core/Package Docsite Split

backports status

Actions

  • @samccann to do a build time simlink from foo_index.rst to index.rst for the 2 index option to eliminate the need for a redirect
  • @samccann to see where intersphinx sends me on each site (aka potentially popping to the wrong site)
  • @acozine to audit internal links to excluded pages on Core site
  • @samccann work with abadger1999 to determine how this works with Ansible package 3.x build out of stable-2.10 and the ability to continue publishing Ansible 2.10 docs for some time to come.

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-02-02/docs_working_group_aka_dawgs.2021-02-02-16.01.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-02-02/docs_working_group_aka_dawgs.2021-02-02-16.01.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-02-02/docs_working_group_aka_dawgs.2021-02-02-16.01.log.html

@samccann
Copy link
Contributor

samccann commented Feb 2, 2021

2021-02-09

opening chatter

new landing pages!

docsite split update

open floor

Logs

Minutes: https://meetbot-raw.fedoraproject.org/ansible-docs/2021-02-09/docs_working_group_aka_dawgs.2021-02-09-16.00.html
Minutes (text): https://meetbot-raw.fedoraproject.org/ansible-docs/2021-02-09/docs_working_group_aka_dawgs.2021-02-09-16.00.txt
Log: https://meetbot-raw.fedoraproject.org/ansible-docs/2021-02-09/docs_working_group_aka_dawgs.2021-02-09-16.00.log.html

@samccann
Copy link
Contributor

samccann commented Feb 9, 2021

2021-02-16

Ansible 3 release and docsite split

  • if push come to shove, we can build Ansible 3 from a private branch w/ the pr backported to stable 2.10 (if we can't get reviews in time to merge into stable-2.10)
    • may not be able to merge the backport to stable-2.10 as it is frozen due to pending release

future of devel documentation

PR/issue labels: ansible/ansibullbot#1505

open floor

Actions

  • @- samccann to fix CI errors by using cp instead of ln and finish other feeback so pr can be merged to devel today
  • @- turn nightly build to core docs once PR is merged into devel
  • @samccann - post last week's meeting minutes on the dawgs agenda
  • @samccann acozine - find out where the /docs folder is in AH roadmap etc

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-02-16/docs_working_group_aka_dawgs.2021-02-16-16.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-02-16/docs_working_group_aka_dawgs.2021-02-16-16.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-02-16/docs_working_group_aka_dawgs.2021-02-16-16.00.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Feb 14, 2021

  • @tadeboro mentioned that users are confused that docs.ansible.com does not show the latest docs for collections released on galaxy. So maybe the community collections should have docsites which also show docs for the latest collection releases? (Cross-post: Community Working Group Meeting Agenda #539 (comment))

@samccann
Copy link
Contributor

samccann commented Feb 16, 2021

@samccann
Copy link
Contributor

samccann commented Feb 23, 2021

2021-03-02

devel docs for the community package

  • 👍 develdocs for /ansible/ always showingdevel` branch of ansible-core plus most recent Galaxy versions of included collections
  • we chose the simplest approach for the Ansible devel docs

collections /docs/ folder

  • TBD what we can do with the collection /docs/ folder as some collections use .md there, others use .rst to repeat module level docs, neither of which work with docs.ansible.com today
  • we would need some script to check for properly formatted labels at the collection rep o CI itself
  • we'd also need 'something' to create unique labels once they are brought into ansible docs build (e.g. prepend collection name)

PR 73676

PR 73170

open floor

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-03-02/docs_working_group_aka_dawgs.2021-03-02-16.01.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-03-02/docs_working_group_aka_dawgs.2021-03-02-16.01.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-03-02/docs_working_group_aka_dawgs.2021-03-02-16.01.log.html

@felixfontein
Copy link
Contributor

In today's community meeting (#539 (comment)), we decided that /devel/ should not include pre-releases of collections. That saves the DaWGs meeting from also discussing that ;-)

@felixfontein
Copy link
Contributor

felixfontein commented Mar 2, 2021

@felixfontein
Copy link
Contributor

felixfontein commented Mar 6, 2021

@samccann
Copy link
Contributor

samccann commented Mar 16, 2021

2021-03-23

meeting time for summer

  • 👍 we will move this meeting one hour earlier starting next week

update on devel docs

breadcrumbs

Actions

  • @acozine to change the UTC time schedule for the DaWGs meeting

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-03-23/docs_working_group_aka_dawgs.2021-03-23-16.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-03-23/docs_working_group_aka_dawgs.2021-03-23-16.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-03-23/docs_working_group_aka_dawgs.2021-03-23-16.00.log.html

@abadger
Copy link
Contributor

abadger commented Mar 23, 2021

I'm double booked this week, so I am posting a little information early in case I'm not watching the meeting when it's discussed

* [ ]  Meeting time  - do we adjust it 30 min earlier?

I can make a meeting 30 minutes to one hour earlier (until Daylight Saving Time shifts again :-)

* [ ]  Ansible (package) devel docs - how can we get the latest collection versions into docs.ansible.com/ansible/devel  (excluding prereleased versions)?

Does this option and implementation look like what we want?

https://hackmd.io/E5a0dw0tTDCteQVVk4VvJw?both#Development-of-ansible-core-and-latest-of-collections

* [ ]  docs for filter/test plugins

It would be great if we can have input on what the structure of this looks like. One of the problems that I found with the current plugin doc data structures is that the names don't follow any common standards. I've addressed that in antsibull-docs by writing a schema which normalizes all of the names prior to giving the data to the rest of the program but it would be better if these were standardized in the specification.

@samccann
Copy link
Contributor

samccann commented Sep 9, 2021

possible RST table for new module attributes are being discussed at - ansible/ansible#75164 (comment)

Tracking issue of all the things we need to get done by core-2.12 release - ansible/ansible#75664

@samccann
Copy link
Contributor

samccann commented Sep 15, 2021

2021-09-21

opening chatter

  • still need to followup on CI testing with Sphinx 4
  • 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)

core-2.12 docs needs

New module attributes

  • background - core supports displaying a batch of 13 or more attributes. See Plugin docs with added attributes are broken ansible#75164 for the debate on the docs side
  • after much deliberation and resorting to a Higher Authority (tm) the decision is to display all the attributes.
  • 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.
  • Add attributes 2/x ansible#75619 is the next step on this in core and still in flux.
  • also, from a usability perspective (mobile apps, etc) - tables are frowned upon
  • 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

ssh doc problem

expand/collapse in sphinx

Open Floor

Actions

  • @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

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-09-21/documentation_working_group_aka_dawgs.2021-09-21-15.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-09-21/documentation_working_group_aka_dawgs.2021-09-21-15.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-09-21/documentation_working_group_aka_dawgs.2021-09-21-15.00.log.html

@samccann
Copy link
Contributor

samccann commented Sep 21, 2021

2021-10-05

agenda

Updates on ongoing work

Actions

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-10-05/documentation_working_group_aka_dawgs.2021-10-05-15.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-10-05/documentation_working_group_aka_dawgs.2021-10-05-15.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-10-05/documentation_working_group_aka_dawgs.2021-10-05-15.00.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Oct 12, 2021

@felixfontein
Copy link
Contributor

felixfontein commented Oct 12, 2021

@felixfontein
Copy link
Contributor

felixfontein commented Oct 12, 2021

@ariordan-redhat
Copy link

ariordan-redhat commented Oct 18, 2021

2021-10-19

opening chatter

Felixfontein's items

Actions

  • @ariordan to reword boilerplate text on collection module page to something like You may already have this collection installed if you are using the ansible package. To check, run ansible-galaxy collection list. If it is not installed, you can install it with:
  • @samccann to try the border shading PR locally and on jenkins so we can test with multiple browsers, on phones/tablets etc

Logs

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

@samccann
Copy link
Contributor

samccann commented Oct 19, 2021

2021-10-26

Action Item review

shaded borders on plugin tables

Meeting time change for Daylight Savings

  • we tend to shift the meeting time (UTC hours) so that it remains the same time for those places who follow Daylight Savings time
  • 👍 Change the UTC calendar so the DaWGs meeting stays the same time for each of us (11am ET, 4pm Irish time, 5pm Felix time) :-)
  • 👍 we will change UTC meeting invites etc this week to align with Daylight Savings shift for Europe
  • moves Docs WG meeting time for summer #602
  • For US folks - this meeting will be an hour LATER, next week, until the US goes into Daylight Savings time the following week

PR76088

Should devel docs use the interim branches of devel?

  • background - core is proposing to create interim branches off devel that are more stable etc. Do we want devel docs to point to those or just keep using the devel branch?
    • pros of keeping devel - we will know instantly if something has gone wrong and can highlight it to be fixed potentially before the next interim branch
  • cons - we could have a busted devel docs for a bit :-)
  • we will keep the devel docs tied to the devel branch so they are the most up-to-date and if anything 'goes wrong' we will know about it asap

Actions

  • @samccann to change the yaml and README.md file in ansible/community to align with this decision
  • @samccann to find out who can change the meeting reminder bot to align with the UTC time change (possiblly 16:00 UTC but need to verify)
  • @samccann to ask same person if we can get a cybclock-clone ping on the 15 min marks here too

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-10-26/documentation_working_group_aka_dawgs.2021-10-26-15.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-10-26/documentation_working_group_aka_dawgs.2021-10-26-15.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-10-26/documentation_working_group_aka_dawgs.2021-10-26-15.00.log.html

@briantist
Copy link

briantist commented Oct 20, 2021

@samccann
Copy link
Contributor

samccann commented Oct 27, 2021

2021-11-02

Action Item review

M() and R() in module docs

updates on ongoing work

Open Floor

Actions

Logs

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

@samccann
Copy link
Contributor

samccann commented Nov 2, 2021

2021-11-09

Action Item review

docs survey issues

reviving semantic markup

  • there's already a PR for antsibull and ansible-doc, so it's mostly things like galaxy-ng/AH, ansible-navigator (in case it formats docs?), and maybe other tools that format docs missing

community-contributed examples

Open Floor

Actions

  • @samccann to confirm expand/collapse PR is correctly setting CI to use sphinx 3 with matt clay
  • @samccann ariordan - expermiment with styling of the expand/collapse bar to make it more visually obvious
  • @samccann to experiment to see if we can set known-good version of sphinx back to 3.0
  • @samccann to follow up with matt clay and gundalow on how to get sphinx up to 4.x in CI
  • @acozine to draft some ideas on when to convert playbook to role for #75508
  • @acozine to make a list of all the pages that use hosts: all for issue #75506
  • @samccann to revive Red Hat conversation on semantic markup and impact on ansible-docs and galaxy-ng/AH etc
  • @ALL - review Adding community-contributed examples to docs or a github repo ansible-community/community-topics#39 for community contributed examples and let's make some progress on this at our next meeting

Logs

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

@samccann
Copy link
Contributor

samccann commented Nov 9, 2021

2021-11-16

Action Item Review

Docs survey feedback

Semantic Markup

Community-contributed examples

Ansible 5 prep

  • we will remove Ansible 4 from the version switcher when Ansible 5 releases

Open Floor

  • if you are having problems building docs locally for Ansible (make webdocs) experiment with ~/.antsibull.cfg, specifically something like thread_max = 3 and max_retries = 15.

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-11-16/documentation_working_group_aka_dawgs.2021-11-16-16.08.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-11-16/documentation_working_group_aka_dawgs.2021-11-16-16.08.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-11-16/documentation_working_group_aka_dawgs.2021-11-16-16.08.log.html

@felixfontein
Copy link
Contributor

felixfontein commented Nov 14, 2021

@ariordan-redhat
Copy link

ariordan-redhat commented Nov 23, 2021

2021-11-30

Action Item Review

setting docs priorities for 2022

  • we have test docs and community docs that need heavy work. Then navigation/toc/general findability. Search has problems. Scenario guides still going stale
  • we need to move forward on responsiveness and semantic markup
  • on search - we should try for faceted search that includes version and module vs non-module search results
  • community team would like their community docs repo better integrated with docs.ansible.com

semantic markup

  • created an internal to Red Hat tracking ticket for the downstream impact

responsive plugin tables

Actions

  • @- rebase and improve visibility formatting for collapsed version of expand/collapse pr Expand test ansible#75695
  • @@samccann to push more on the community and internal RH tickets for semantic markup decisions
  • @samccann_ to verify /latest/ publication uses known-good requirements file and /devel/ uses requirements.txt with an open antsibull version
  • @gwmngilfen to review the proposed schema

Logs

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

@samccann
Copy link
Contributor

samccann commented Nov 30, 2021

2021-12-07

Action Item Review

Responsive parameter tables

semantic markup

  • since semantic markup impacts products like Automation Hub, we cannot merge these until core-2.14 timeframe as all the roadmaps based on 2.13 have been finalized.
  • next step is a formal spec for this to be reviewed in community and then internally for these dependent products

docs vs docs-tooling and attracting more contributors

  • we should highlight a part of the agenda dedicated to documentation so newcomers know when we will talk docs vs docs tooling

Open Floor

Actions

  • @samccann to publish Responsive parameter/... tables ansible-community/antsibull-build#335 to test before we merge
  • @felixfontein to merge 335 (responsive parameters) and move forward with next steps to an antsibull release
  • @samccann felixfontein -work on semantic markup formal spec in hackmd
  • @samccann cybette work on a 'Help wanted' section on the bullorn to add 'easyfix' issues or other ideas where people can hop in and help
  • @samccann to revamp the agenda to frontload some documentation issues/PRs/ideas before the tooling stuff...make nice headers ;-)
  • @Gwmngilfen to work on finalizing linking metadata for collections and turning it into a proposal

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-12-07/documentation_working_group_aka_dawgs.2021-12-07-16.02.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-12-07/documentation_working_group_aka_dawgs.2021-12-07-16.02.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-12-07/documentation_working_group_aka_dawgs.2021-12-07-16.02.log.html

@samccann
Copy link
Contributor

samccann commented Dec 7, 2021

2021-12-14

opening chatter

Documentation work

Docs-tooling

docs examples

semantic markup

Open Floor

Actions

  • @samccann to open an antsibull issue to see if we can list just new collections at top of porting guide. If not, change wording for changelog link to say see it for full list of collections
  • @- samccann to try a reminder bot on US and APAC times with links to open issues and prs (but no room bot nag)
  • @samccann to get easyfix docs issues into the newsbot

Logs

Minutes: https://meetbot.fedoraproject.org/ansible-docs/2021-12-14/documentation_working_group_aka_dawgs.2021-12-14-16.00.html
Minutes (text): https://meetbot.fedoraproject.org/ansible-docs/2021-12-14/documentation_working_group_aka_dawgs.2021-12-14-16.00.txt
Log: https://meetbot.fedoraproject.org/ansible-docs/2021-12-14/documentation_working_group_aka_dawgs.2021-12-14-16.00.log.html

@samccann
Copy link
Contributor

samccann commented Dec 14, 2021

2021-12-21

opening chatter

Documentation updates

docs tooling updates

Open Floor and eggnog time!

  • no DaWGs meeting next week. Very few folks will be around

Actions

  • @samccann find a way to use remindbot with newsbot to add Help Wanted on easyfix items each week
  • @samccann close out 2021 DaWGs agenda issue and create a new on for the new year

Logs

Minutes: https://meetbot-raw.fedoraproject.org/ansible-docs/2021-12-21/documentation_working_group_aka_dawgs..._%28full_message_at_https:libera.ems.host_matrixmediar0downloadlibera.chat18f89f3e2b8171212d1adc29780a2124eadc5840%29.2021-12-21-16.01.html
Minutes (text): https://meetbot-raw.fedoraproject.org/ansible-docs/2021-12-21/documentation_working_group_aka_dawgs..._%28full_message_at_https:libera.ems.host_matrixmediar0downloadlibera.chat18f89f3e2b8171212d1adc29780a2124eadc5840%29.2021-12-21-16.01.txt
Log: https://meetbot-raw.fedoraproject.org/ansible-docs/2021-12-21/documentation_working_group_aka_dawgs..._%28full_message_at_https:libera.ems.host_matrixmediar0downloadlibera.chat18f89f3e2b8171212d1adc29780a2124eadc5840%29.2021-12-21-16.01.log.html

@samccann
Copy link
Contributor

Closing this issue. Please add agenda items to the new 2022 issue - #643

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs related to documentation meeting_agenda
Projects
None yet
Development

No branches or pull requests

7 participants