-
-
Notifications
You must be signed in to change notification settings - Fork 26
Minutes from April 2025 #152
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
21ecd67
Minutes from April 2025
AA-Turner 2428309
Spelling
AA-Turner ffd1804
fixup! Minutes from April 2025
AA-Turner 7ddd2e8
Remove whitespace
AA-Turner b292d68
Change to new anchor
AA-Turner 383c087
Changes
AA-Turner 33d5e1c
Apply suggestions from code review
AA-Turner File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,178 @@ | ||
# Documentation Community Team Meeting (April 2025) | ||
|
||
:::info | ||
- **Date:** 2025-04-01 | ||
- **Time:** [19:00 UTC](https://arewemeetingyet.com/UTC/2025-04-01/19:00/Docs%20Meeting) | ||
- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1> | ||
- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-1st-april-2025/85787) (for April) | ||
- [**Meeting reports**](https://docs-community.readthedocs.io/monthly-meeting/) (the latest one might be an [**unmerged PR**](https://github.com/python/docs-community/pulls)) | ||
- **Calendar event:** (send your e-mail to Mariatta for an invitation) | ||
- **How to participate:** | ||
- We are using Discord: <https://discord.gg/vKTkwJKG?event=1347635566518210613> | ||
<!-- Not this month!!: Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) 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 (for example, with a GitHub account). | ||
::: | ||
|
||
By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). | ||
Please take a second to read through it! | ||
|
||
|
||
Example topics for discussion: | ||
|
||
* Python project documentation: *relating to `docs.python.org`, `peps.python.org`, `devguide.python.org`, etc.* | ||
* 'Internal' items: *for and about the Community or Working Group* | ||
* PEP workflow | ||
* Follow-ups from previous meetings | ||
|
||
|
||
|
||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
## Roll call | ||
|
||
(Name / `@GitHubUsername` *[/ Discord, if different]*) | ||
|
||
- Adam Turner / `@AA-Turner` | ||
- Blaise Pabon / `@controlpl4n3` | ||
- Hugo van Kemenade / `@hugovk` | ||
- Keith / `@KeithTheEE` | ||
- Jeff Jacobson | ||
- Ryan Duve / `@ryan-duve` | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Daniele Procida / `@evildmp` | ||
- Stan Ulbrych / `@StanFromIreland` | ||
|
||
|
||
|
||
## Introductions | ||
|
||
> If there are any new people, we should do a round of introductions. | ||
|
||
|
||
## Reports and celebrations | ||
|
||
> 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. | ||
|
||
> 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. | ||
|
||
- [Stan] | ||
|
||
Python Translations Progress Update | ||
| Language | 30 days progress | | ||
| -------- | ------------------ | | ||
| Brazilian Portuguese | +0.91% | | ||
| Simplified Chinese | +0.56% | | ||
| Romanian | +0.30% | | ||
| Russian | +0.20% | | ||
| Japanese | +0.16% | | ||
| Traditional Chinese | +0.09% | | ||
| Greek | +0.08% | | ||
|
||
For reference, the current wordcount of the Docs is: | ||
1,524,334. | ||
|
||
Source: [index.json as of Apr 1, 16:26](https://github.com/python-docs-translations/dashboard/blob/fed87b1e8bbbb809953e5eeac6ba8f59101c26cd/index.json) | ||
|
||
- Petr's work on the grammar documentation is on hold for the moment, but going well. | ||
|
||
|
||
## Discussion | ||
|
||
### `python-releases.toml` | ||
|
||
- Adam gave a brief overview of a project to collate metadata for all releases of Python since 1.6. | ||
See [python/peps#4331](https://github.com/python/peps/pull/4331). | ||
|
||
### Indonesian translation | ||
|
||
- Jeff asked how the Indonesian translation could be reinvigorated, | ||
as currently there is no activity on repo. What are the next steps? | ||
- Hugo suggested that Jeff could be the next translation coordinator, in order to make a start with PRs and so on. | ||
This would be a first step to rebuilding the Indonesian translation team team. | ||
- Agreed that Jeff will open an issue on the [Editorial Board repo](https://github.com/python/editorial-board) asking to do so and with a summary of this discussion. | ||
|
||
### Translation governance | ||
|
||
- With the translations, we want to let translators get on with their work, rather than getting in the way. | ||
- There is a gap of who can approve/manage changes to language coordinators, repo permissions in the Python organisation, etc. | ||
- General agreement for a light-touch & pragmatic approach to managing language coordinators, | ||
for example approving any coordinator nominated by a core developer, or a similar policy. | ||
- Translations fall within the Editorial Board's remit, so they might decide a policy statement. | ||
- Stan has suggested some changes to PEP 545 on [Discourse](https://discuss.python.org/t/83534) about translation management (dealing with inactive translators), translation quality (mass pushing of poor quality machine translations) and improving methods of finding translators (All currently awaiting SC review) and another [Discourse](https://discuss.python.org/t/75750/3) on switcher requirements (inconclusive), | ||
but these weren't discussed due to audio problems. | ||
|
||
### Ensemble contributor session | ||
|
||
- Blaise noted he will host a 90-min ensemble session for intermediate to advanced contributors this Friday, | ||
as an exercise to get folk used to using Python codebase. | ||
- The topic will be related to https://github.com/python/cpython/issues/127833 but there is no rigid agenda. | ||
- Invitation: https://calendar.app.google/5hjYyVRSjJN5MwdEA | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Editorial Board update & documentation audits | ||
|
||
- Ned gave a brief update from the Editorial Board. | ||
- Joanna Jablonski (editor, *Real Python*) and Savannah Ostrowski (core developer) are conducting *documentation audits*. | ||
- These are a formal approach to assessing gaps in documentation and approaching from disciplined first principles. | ||
- The pair are planning an audit of the *argparse* docs, with the indent to repeat the process elsewhere in the documentation. | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Potential PR process improvements | ||
|
||
- What process changes could we explore to increase velocity of merged docs PRs? | ||
Ideally 'easy wins' rather than sweeping changes. | ||
- Should we suggest: | ||
|
||
* making a single large PR containing all proposed changes? | ||
* making many small PRs with individual changes? | ||
* simply waiting for a reviewer? | ||
|
||
- The open documentation PRs are slowly increasing, and now at around 240. | ||
- Ned notes that a frequent blocker is that a seemingly small change can represent a philosophical decision, which take time to reach consensus on. | ||
Experienced reviewers can spot these types of change quite quickly. How do we communicate this to new contributors? | ||
- It is disheartening to have a first PR languish unreviewed, or have 70 comments of back-and-forth debate. | ||
- Hugo noted the exemplar of the *string examples* PR, seeking to add an example snippet to each `str` method. | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
This is unreviewable with everything in one PR, but e.g. splitting to many small PRs might help refine the process. | ||
Just a single change request blocks an entire PR, whereas smaller PRs are easier to merge quickly. | ||
|
||
- Perhaps we could experiment with defining a tracker issue and splitting it into small tasks. | ||
Coordination problems or design decisions can be solved on the tracker issue. | ||
- Daniele noted that if this got traction, many small atomic changes could be a good approach. | ||
Each might look banal, but are part of a larger whole, and once the first few are approved, | ||
the reviewer starts to see patterns, reviewing is very quick, and the review experience is nicer. | ||
- Many small PRs might look like more overhead, but it's not. | ||
- Perhaps we could try this with the `str` examples PR? | ||
|
||
### Synchronous contributions | ||
|
||
- Blaise noted that the experience of the Pycon sprints was valuable, being able to do work, get stuck, and then carry on. | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
These settings give the freedom to interrupt and get help from more experienced contributors. | ||
- Technical writers, such as those in the *Write the Docs* slack, would like to help, but don't know where to begin, and a session like this could help. | ||
AA-Turner marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- Are there changes we can make to improve the 'just start writing' experience for technical writers, who aren't necessarily programmers? | ||
|
||
### PR templates | ||
|
||
- Ned noted that it's worth trying anything that might get more people involved. | ||
- One problem with the PR template in the CPython repo is that it needs to cover every kind of contribution. | ||
It's hard to word things in a way that docs people would find interesting. | ||
- The PEPs repo uses multiple PR templates for different types of changes, perhaps this could be explored in CPython. | ||
- The feature doesn't work perfectly, it is easy to (accidentally) bypass the template and open a blank PR. | ||
- Agreed that it is likely still worth experimenting, as even if the text is missed, it can be pointed to after the fact. | ||
|
||
|
||
### Wiki news | ||
|
||
- Keith gave a brief update on the Python Wiki. | ||
- The Python Software Foundation (PSF) board may create a focus group for this work as several people are interested, | ||
which could mean more resources available, and would not block people doing anything. | ||
- No other substantive news. | ||
- The wiki server has been upgraded to a better VM so will hopefully be offline less often. | ||
|
||
### Weblate | ||
|
||
- Progress is being made on a paid translation platform. | ||
|
||
*[Monthly reports archive](https://docs-community.readthedocs.io/en/latest/monthly-meeting/index.html)* | ||
|
||
|
||
## Next meeting | ||
|
||
The docs team generally meets on the first Tuesday of every month around 19:00-ish UTC. | ||
|
||
We have a recurring Google Calendar event for the meeting. | ||
Let Mariatta know your email address and she can invite you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.