|
| 1 | +# Documentation Community Team Meeting (December 2023) |
| 2 | + |
| 3 | +:::info |
| 4 | +- **Date:** 2023-12-05 |
| 5 | +- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2023-12-05/20:00/Docs%20Meeting) |
| 6 | +- **This HackMD:** https://hackmd.io/@encukou/pydocswg1 |
| 7 | +- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-december-5-2023/40119) (for December) |
| 8 | +- [**Meeting reports**](https://docs-community.readthedocs.io/en/latest/monthly-meeting/) (the latest one might be an [**unmerged PR**](https://github.com/python/docs-community/pulls)) |
| 9 | +- **Calendar event:** (send your e-mail to Mariatta for an invitation) |
| 10 | +- **How to participate:** |
| 11 | + - Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) and ask to be let in. |
| 12 | + - 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). |
| 13 | +::: |
| 14 | + |
| 15 | +By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). |
| 16 | +Please take a second to read through it! |
| 17 | + |
| 18 | +## Roll call |
| 19 | + |
| 20 | +(Name / `@GitHubUsername` *[/ Discord, if different]*) |
| 21 | +- Petr Viktorin / `@encukou` |
| 22 | +- Daniele Procida / `@danieleprocida` |
| 23 | +- Hugo van Kemenade / `@hugovk` |
| 24 | +- Jim DeLaHunt / `@JDLH` |
| 25 | +- Ryan Duve / `@ryan-duve` |
| 26 | +- Ned Batchelder / `@nedbat` |
| 27 | +- Bradley / `@shenanigansd` |
| 28 | +- Ezio Melotti / `@ezio-melotti` |
| 29 | +- CAM Gerlach / `@CAM-Gerlach` |
| 30 | +- Usman Akinyemi / `@Unique-Usman` |
| 31 | + |
| 32 | +## Introductions |
| 33 | + |
| 34 | +> If there are any new people, we should do a round of introductions. |
| 35 | +
|
| 36 | +## Discussion |
| 37 | + |
| 38 | +* [Ryan] standard library documentation reference and adding types to it in a structured way. For example, `collections.Counter.most_common` could be written |
| 39 | + |
| 40 | + most_common(n: int) -> list[tuple[Any, int]] |
| 41 | + |
| 42 | + [Petr] ... or `list[tuple[KeyType, int]]`? |
| 43 | + |
| 44 | + - this has been discussed. There was opposition to adding the types to the stdlib code itself. |
| 45 | + - [JDLH] I sometimes wish for more normative, less chatty module documentation. e.g. [*heapq* module](https://docs.python.org/3/library/heapq.html). e.g. old issue 29428 [*Doctest documentation unclear about multi-line fixtures*](https://bugs.python.org/issue29428). |
| 46 | + |
| 47 | +* [Petr] Use emoji to illustrate good and bad example commit messages |
| 48 | + * https://devguide.python.org/getting-started/git-boot-camp/#accepting-and-merging-a-pull-request |
| 49 | + * [python/devguide#1235](https://github.com/python/devguide/pull/1235) |
| 50 | + * Should we do this for PEPs? see [python/docs-community#22](https://github.com/python/docs-community/issues/22) |
| 51 | + * [Hugo] See also [python/peps#3567](https://github.com/python/peps/pull/3567) for green/red sidebars for good/bad example code in PEPs |
| 52 | + * [JDLH] don't forget accessibility constraints when coming up with the style guide. e.g. some readers are red/green colourblind. ✅❌ are good in that they are legible even without colour. |
| 53 | + |
| 54 | +* [Ryan] Thoughts about completing TOML->JSON conversion table: https://docs.python.org/3/library/tomllib.html#conversion-table and the TOML spec: https://toml.io/en/v1.0.0#spec |
| 55 | + |
| 56 | + |
| 57 | +## Reports and celebrations |
| 58 | + |
| 59 | +> 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. |
| 60 | +
|
| 61 | +> This is a place to make announcements (without a need for discussion). This is also a great place to give shout-outs to contributors! We'll read through these at the beginning of the meeting. |
| 62 | +
|
| 63 | + |
| 64 | +- PEP 732 ("The Python Documentation Editorial Board") has been submitted to the steering council [python/steering-council#220](https://github.com/python/steering-council/issues/220) |
| 65 | + |
| 66 | +- [Jim] FYI, Unicode Standard is changing form of authoritative standard documents from PDF to HTML, with corresponding change to document production tooling. If this is interesting I can provide more info. I am in the working group which is working on the new tooling. |
| 67 | + |
| 68 | +## Follow-ups from previous meeting(s) |
| 69 | + |
| 70 | +* [Petr] [Railroad diagrams](https://discuss.python.org/t/36709/20) |
| 71 | + * Streams have kinda been on other topics too |
| 72 | + |
| 73 | +* Analytics (Plausible) - CAM sent an e-mail, no reply yet |
| 74 | + * CAM sent multiole followups |
| 75 | + * Hugo sent a followup two weeks ago |
| 76 | + * Discussion on core dev Discord that is supportive |
| 77 | + * Still no reply... :( |
| 78 | + |
| 79 | +* As a beginner, what's a good starting point? |
| 80 | + * There are some "easy" issues, although they can occasionally not be actually-easy. |
| 81 | + * Interested in documentation, look at diataxis and make changes? |
| 82 | + * Diataxis is kinda abstract for newcomers. |
| 83 | + * |
| 84 | + |
| 85 | + |
| 86 | +### 'Internal' items |
| 87 | + |
| 88 | +*For and about the Community or Working Group* |
| 89 | + |
| 90 | + |
| 91 | +### Python Project Documentation |
| 92 | + |
| 93 | +*Relating to `docs.python.org`, `peps.python.org`, `devguide.python.org`, etc.* |
| 94 | + |
| 95 | +- ... |
| 96 | + |
| 97 | +### PEP Workflow |
| 98 | + |
| 99 | +- ... |
| 100 | + |
| 101 | +## Next meeting |
| 102 | + |
| 103 | +The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC. |
| 104 | + * [JDLH] The first Tuesday of next month is 2 January. Will we be ready for this meeting on the day after New Year's Day? Answer: Basically yes; those who are ready will show up, others won't. |
| 105 | + |
| 106 | +We have a recurring Google Calendar event for the meeting. |
| 107 | +Let Mariatta know your email address and she can invite you. |
0 commit comments