|
| 1 | +# Documentation Community Team Meeting (March 2025) |
| 2 | + |
| 3 | +- **Date:** 2025-03-04 |
| 4 | +- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2025-03-04/20:00/Docs%20Meeting) |
| 5 | +- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1> |
| 6 | +- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-4th-march-2025/82201) |
| 7 | + (for March) |
| 8 | +- [**Meeting reports**](https://docs-community.readthedocs.io/en/latest/monthly-meeting/) |
| 9 | + (the latest one might be an |
| 10 | + [**unmerged PR**](https://github.com/python/docs-community/pulls)) |
| 11 | +- **Calendar event:** (send your e-mail to Mariatta for an invitation) |
| 12 | +- **How to participate:** |
| 13 | + - We are using Discord this time: |
| 14 | + <https://discord.gg/fbCgH3hF?event=1338927163885359214> |
| 15 | + - To edit notes, click the “pencil” or “split view” button on the |
| 16 | + [HackMD document](https://hackmd.io/@encukou/pydocswg1). You need to log in (for |
| 17 | + example, with a GitHub account). |
| 18 | + |
| 19 | +By participating in this meeting, you are agreeing to abide by and uphold the |
| 20 | +[PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). Please take a second |
| 21 | +to read through it! |
| 22 | + |
| 23 | +## Roll call |
| 24 | + |
| 25 | +(Name / `@GitHubUsername` _[/ Discord, if different]_) |
| 26 | + |
| 27 | +- Carol |
| 28 | +- Maciek |
| 29 | +- Petr Viktorin / `@encukou` |
| 30 | +- Hugo van Kemenade / `@hugovk` |
| 31 | +- Keith / `@KeithTheEE` |
| 32 | +- Jeff |
| 33 | +- Ryan Duve / `@ryan-duve` |
| 34 | + |
| 35 | +## Introductions |
| 36 | + |
| 37 | +> If there are any new people, we should do a round of introductions. |
| 38 | +
|
| 39 | +None this time. |
| 40 | + |
| 41 | +## Reports and celebrations |
| 42 | + |
| 43 | +> 60 second updates on things you have been up to, questions you have, or developments |
| 44 | +> you think people should know about. Please add yourself, and if you do not have an |
| 45 | +> update to share, you can pass. |
| 46 | +
|
| 47 | +> This is a place to make announcements (without a need for discussion). This is also a |
| 48 | +> great place to give shout-outs to contributors! We'll read through these at the |
| 49 | +> beginning of the meeting. |
| 50 | +
|
| 51 | +- [Hugo] New translations: |
| 52 | + - A new Romanian translation has been started and they're looking to build the team. |
| 53 | + Spread the word! [octaG-M/Python-in-ro](https://github.com/octaG-M/Python-in-ro) |
| 54 | + - Persian is being restarted: |
| 55 | + [revisto/python-docs-fa](https://github.com/revisto/python-docs-fa) |
| 56 | + - And we have a volunteer to pick up Bengali |
| 57 | +- Sphinx 8.2 released 🎉 |
| 58 | + [changelog](https://www.sphinx-doc.org/en/master/changes/8.2.html) |
| 59 | +- [Maciek] Translations progress (30 days): |
| 60 | + - zh-cn: 0.6% |
| 61 | + - es: 0.1% |
| 62 | + - pt-br: 1.53% |
| 63 | + - uk: 0.09% |
| 64 | + - zh-tw: 0.73% |
| 65 | + - pl: 1.83% |
| 66 | + - gr (el): 1.58% |
| 67 | + - We now show last 30 days progress on the dashboard (kudos to Stan). |
| 68 | + |
| 69 | +## Discussion |
| 70 | + |
| 71 | +- [Hugo] wiki.python.org |
| 72 | + |
| 73 | + - Elena from Australia has been finding important info in the wiki, focused on |
| 74 | + communities. Keith is interested in education & outreach. |
| 75 | + - [Keith] There are multiple groups who decided recently that something should happen |
| 76 | + to the wiki. It would be nice to organize that, and part of that is understanding |
| 77 | + the scope. |
| 78 | + - What is the relationship between the docs & the wiki? |
| 79 | + - [Hugo] The old info is not useful, but people are still updating the wiki and adding |
| 80 | + useful info. |
| 81 | + - Info in the docs should not be duplicated in the wiki. We should avoid linking to |
| 82 | + the wiki; if we do link we should be explicit that this is a community-maintained |
| 83 | + wiki. |
| 84 | + - [Carol] I know that some people like the wiki, but it's not a good place for project |
| 85 | + documentation. |
| 86 | + - [Keith] From the education & outreach perspective & former Python subredditor & |
| 87 | + Python Discord mod: people who find the wiki very quickly get to outdated |
| 88 | + information. We want to change that. |
| 89 | + - Moving wiki to Git is an interesting idea, but takes a lot of work. If we start |
| 90 | + updating, people will start saying “my resource should be here too” |
| 91 | + - [Carol] audited the python.org & links two levels from Documentation, made sure |
| 92 | + links to official docs are first, then educational resources, then the wiki. It |
| 93 | + shouldn't be the first place people go to for information. |
| 94 | + - [Keith] Is the audit publicly available? What is a good format to make an audit, so |
| 95 | + we can share actionable information? |
| 96 | + - [Carol] can share that with Keith & Elena |
| 97 | + - [Keith] What's a good format? How do we avoid duplicating work and move to some |
| 98 | + version of “better”? |
| 99 | + - [Carol] Start at the homepage, see where the links lead |
| 100 | + - From the history, it's best to approach it as an external resource. That is in some |
| 101 | + ways how it's been managed. From an education point of view, it would be good to get |
| 102 | + the homepage to the point where it would be good for new contributors. |
| 103 | + - [Maciek] On Wikipedia, they use bots to add “this is outdated” banners. Should we |
| 104 | + try to do that? Add banners for up-to-date content, redirects to newer resources for |
| 105 | + outdated info? |
| 106 | + - [Hugo] The wiki will be updated to new MoinMoin soon, let's not do automation now. |
| 107 | + - Some news sites have also been adding banners for older articles. |
| 108 | + - [Keith] How would you define wiki content that should be moved to docs.python.org? |
| 109 | + - [Hugo] d.p.o is mainly focused on the tutorial and reference guide; it should fit |
| 110 | + there. |
| 111 | + - [Carol] Historical information -- something Guido or Barry wrote early on to give |
| 112 | + context -- we should move that as well. Perhaps not to docs.python.org, but |
| 113 | + somewhere else under python.org. |
| 114 | + - [Ryan] Diátaxis says what should go in docs; if it's not in one of the categories it |
| 115 | + should not go in docs. |
| 116 | + - [Keith] Lots of good things to talk about; I don't know what my conclusion will be |
| 117 | + - [Carol] It would be great if the Education & Outreach Workgroup makes a landing |
| 118 | + page, perhaps with content from the wiki. |
| 119 | + - [Keith] That's the end goal |
| 120 | + |
| 121 | +- [Hugo] Any news from the EB? |
| 122 | + |
| 123 | + - [Carol] They have met, I've missed a few meetings. Will meet next week, maybe we can |
| 124 | + put something public up. There are plans to audit of some of the docs. |
| 125 | + |
| 126 | +- [Hugo] We're using the latest version of Sphinx for latest version of the docs and the |
| 127 | + bugfix versions. Previously we limited this to what various distributors use. That |
| 128 | + also means that if we need something new in the docs, we can add it to Sphinx |
| 129 | + relatively quickly. |
| 130 | + |
| 131 | +- [Maciek] Translation dashboard: we started to track the change in last 30 days; it's |
| 132 | + shown with a different colour. |
| 133 | + |
| 134 | + - Sphinx build warnings and lint errors are in progress. |
| 135 | + |
| 136 | +- [Hugo] Ryan, you made some PRs, are they getting reviews? |
| 137 | + - [Ryan] Going great! |
| 138 | + |
| 139 | +## Next meeting |
| 140 | + |
| 141 | +The docs team generally meets on the first Tuesday of every month around 20:00-ish UTC. |
| 142 | + |
| 143 | +We have a recurring Google Calendar event for the meeting. Let Mariatta know your email |
| 144 | +address and she can invite you. |
0 commit comments