Documentation Community Team Meeting (November 2022)#
Time: 19:30 UTC
This HackMD: https://hackmd.io/@encukou/pydocswg1
Discourse thread (for November)
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] (https://hackmd.io/@encukou/pydocswg1). 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!
Jim DeLaHunt / @JDLH
Ezio Melotti /
Erlend Aasland / @erlend-aasland
Hugo van Kemenade /
Ned Batchelder /
C.A.M. Gerlach /
Petr Viktorin /
Quick updates - Introductions#
60 second updates on things you have been up to, questions you have, or developments you think people should know about. Please add yourself, and if you do not have an update to share, you can pass.
Mariatta: Python BR keynote
Jim DeLaHunt: pass
Ezio: devguide, CSV with status of Python branches, OpenGraph metadata for devguide et al., catching up after a busy month
Erlend: getting help from Cam on two huge PRs on SQLite docs
Hugo: OpenGraph extension on DevGuide, created PR on Sphinx extension to improve SEO, now does
meta descriptionin addition to
meta og:..., plus bug fix in
dirhtmlused to generate the pages.
Cam: attended core dev sprint, helped a lot of people get things done. Will work on what’s new. New Sphinx roles for linking Python source code & GitHub. automate checking if things added in new version is documented, docstrings updated, deprecation tracking.
(Alex) “object doesn’t have an
__exit__yet docs say it does” might be interesting to discuss
concern with renaming/changing text will break links (specifically, fragment parts of URL e.g.
it’s better to add a paragraph above explaining it. even though readers may not read the paragraph, at least we can still point people to it, instead of breaking links.
Infrastructure & detecting/avoiding broken links
how to get visibility of docs traffic and broken url hits?
First step: ask #PSF category on Discourse.
Done, see Discourse thread —JDLH
Probably Ee @EWDurbin oversees this, but better not to start there, Ee is busy.
need help from Ee about docs preview on Netlify
sphinxext-rediraffecan check at the source level
(Hugo) Add release cycle chart to docs
Ezio: fix conflicts in python/devguide#884
Then, merge the chart generation
For and about the Community or Working Group
Better time slot for the meeting
Maybe let’s alternate the Monday slot with another time, so other ppl can join?
CAM to start a poll for a good time slot. (Poll now live)