Documentation Community Team Meeting (April 2023)

• Date: 2023-04-03

• Time: 19:00 UTC

• This HackMD: https://hackmd.io/@encukou/pydocswg1

• Discourse thread (for April)

• Meeting reports (the latest one might be an unmerged PR)

• Calendar event: (send your e-mail to Mariatta for an invitation)

• How to participate:

  • Go to Google Meet and ask to be let in.

  • To edit notes, click the “pencil” or “split view” button on the HackMD document. You need to log in (e.g. with a GitHub account).

By participating in this meeting, you are agreeing to abide by and uphold the PSF Code of Conduct. Please take a second to read through it!

Roll call

(Name / @GitHubUsername)

• Petr Viktorin (@encukou)

• Mariatta (@mariatta)

• CAM (@CAM-Gerlach)

• Hugo (@hugovk)

• Joanna (@jablonskidev)

• Ned (@nedbat)

Introductions

Welcome Joanna

Reports and celebrations

• Dark theme for docs.python.org now live! Thanks Hugo!

• Final PEPs and the canonical docs banner link now merged, thanks Pradyun (and Hugo)!

  • See PEP 621 for a live example

• Sphinx warnings for nit-picky mode (undefined references) merged!

  • show Sphinx warnings in changed files, can’t fail

  • show Sphinx warnings in required-list (e.g. What’s New in 3.12), can fail

  • Further followups in python/cpython#103116, python/cpython#103135 and python/cpython#103191 all merged!

  • blurb PR to avoid spaces in filenames

Discussion

• Netlify preview links are in

• Docs Editorial [Board?]

  • There’s editorial board (who’s in it, how to get the “authority”)

• More feedback, input and questions from Joanna, hopefully!

  • what’s blocking people from contributing?

    • time, money

    • is there problem with some part of process

    • CAM: has been productive, but still have time & money constraints

    • lack of direction, authority

    • impostor syndrome, what can we do?

    • Needs organization, we can do something about it

    • Funding: some programs exist like Season of Docs

    • Contributing to docs is considered second class. (It is not here).

  • volunteering

    • we can’t tell people what to do, but we can guide and direct them.

• potential tasks/issues for PyCon US sprint

  • moving PEP 636

• who wants to volunteer to be the authority of editorial?

Python Project Documentation

Relating to docs.python.org, peps.python.org, devguide.python.org, etc.

Followups from last month(s)?

• Lutra! Improving the bus factor, accessibility and next steps?

• Move PEP 636 (Structural Pattern Matching: Tutorial) to main docs

  • See Discourse thread

• concurrent.futures reorgantization

  • See Diataxis website and Diataxis workshop videos for more information on organization

Next meeting

The docs team generally meets on the first Monday of every month.

We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you.