Documentation Community Team Meeting (November 2023)¶
Date: 2023-11-07
Time: 20:00 UTC
This HackMD: https://hackmd.io/@encukou/pydocswg1
Discourse thread (for November)
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
[/ Discord, if different])
Marcus Sherman /
@betteridiot
Petr Viktorin /
@encukou
Ned Batchelder /
@nedbat
Ege Akman /
@egeakman
Ezio Melotti /
@ezio-melotti
Hugo van Kemenade /
@hugovk
Usman Akinyemi /
@Unique_Usman
Blaise Pabon /
@blaisep
/BlaisePabon
Ryan Duve /
@ryan-duve
Pradyun Gedam /
@pradyunsg
Reports and celebrations¶
PEP 732 “The Python Documentation Editorial Board” draft has been published:
Establishes the docs Editorial Board, and the relationship to the docs community
The idea is that the board can make larger, far-reaching decisions than just people sending PRs
Joanna is the author, she used to work at Real Python
How do you join the group? A. It’s a small group with appointed members, not like this community.
How exactly the decisions will be made is still to be worked out.
This (docs community) is called the “working group”
[Petr] Issues from the docs@python.org were converted to a list in a GitHub issue
Discussion¶
[Petr] Railroad diagrams
Next stream: https://youtube.com/live/vHn4YqzYlPo
[Ege] Looking for help on python-docs-bootstrapper
Need help with:
packaging (done thanks to Hugo)
CLI enhancements and features
If you have some spare time and nothing else to do, feel free to contribute!
[Adam/Ege/Hugo] Frequency of docs.python.org builds
We used to build all translations & versions
Now we only build those that have changed, which reduces the build time.
There is still room for improvement: python/docsbuild-scripts#171 (comment)
[Ege/Hugo/CAM] Analytics (Plausible) - CAM sent an e-mail (around late October), no reply yet
[Usman] As a beginner, what’s a good starting point?
There are some “easy” issues, although they can occasionally not be actually-easy.
Interested in documentation, look at diataxis and make changes?
Diataxis is kind of abstract for newcomers.
Next meeting¶
The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC.
We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you.