Skip to content

Add March 2025 meeting notes #147

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
merged 5 commits into from
Mar 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .codespellrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[codespell]
ignore-words-list = Ege, Ned
7 changes: 7 additions & 0 deletions .github/workflows/lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,10 @@ jobs:
with:
python-version: "3.x"
- uses: pre-commit/action@v3.0.1

codespell:
runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- uses: codespell-project/actions-codespell@v2
11 changes: 8 additions & 3 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
repos:
- repo: https://github.com/psf/black-pre-commit-mirror
rev: 24.4.2
rev: 25.1.0
hooks:
- id: black

- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: check-case-conflict
- id: check-merge-conflict
Expand All @@ -14,10 +14,15 @@ repos:
- id: trailing-whitespace

- repo: https://github.com/sphinx-contrib/sphinx-lint
rev: v0.9.1
rev: v1.0.0
hooks:
- id: sphinx-lint

- repo: https://github.com/codespell-project/codespell
rev: v2.4.1
hooks:
- id: codespell

- repo: meta
hooks:
- id: check-hooks-apply
Expand Down
2 changes: 2 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@
# The crawler gets "Anchor not found"
r"https://github.com.+?#.*",
r"https://hackmd\.io/[^?]+\?[^#]+#.+",
# Google Meet gives 404
r"https://meet.google.com/.*",
# RTD preview builds:
r"https://[a-zA-Z0-9.-]+\.org\.readthedocs\.build/[a-zA-Z0-9.-]+/[a-zA-Z0-9.-]+/",
# Deleted pages:
Expand Down
144 changes: 144 additions & 0 deletions docs/monthly-meeting/2025-03.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Documentation Community Team Meeting (March 2025)

- **Date:** 2025-03-04
- **Time:** [20:00 UTC](https://arewemeetingyet.com/UTC/2025-03-04/20:00/Docs%20Meeting)
- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1>
- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-4th-march-2025/82201)
(for March)
- [**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))
- **Calendar event:** (send your e-mail to Mariatta for an invitation)
- **How to participate:**
- We are using Discord this time:
<https://discord.gg/fbCgH3hF?event=1338927163885359214>
- 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!

## Roll call

(Name / `@GitHubUsername` _[/ Discord, if different]_)

- Carol
- Maciek
- Petr Viktorin / `@encukou`
- Hugo van Kemenade / `@hugovk`
- Keith / `@KeithTheEE`
- Jeff
- Ryan Duve / `@ryan-duve`

## Introductions

> If there are any new people, we should do a round of introductions.

None this time.

## 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.

- [Hugo] New translations:
- A new Romanian translation has been started and they're looking to build the team.
Spread the word! [octaG-M/Python-in-ro](https://github.com/octaG-M/Python-in-ro)
- Persian is being restarted:
[revisto/python-docs-fa](https://github.com/revisto/python-docs-fa)
- And we have a volunteer to pick up Bengali
- Sphinx 8.2 released 🎉
[changelog](https://www.sphinx-doc.org/en/master/changes/8.2.html)
- [Maciek] Translations progress (30 days):
- zh-cn: 0.6%
- es: 0.1%
- pt-br: 1.53%
- uk: 0.09%
- zh-tw: 0.73%
- pl: 1.83%
- gr (el): 1.58%
- We now show last 30 days progress on the dashboard (kudos to Stan).

## Discussion

- [Hugo] wiki.python.org

- Elena from Australia has been finding important info in the wiki, focused on
communities. Keith is interested in education & outreach.
- [Keith] There are multiple groups who decided recently that something should happen
to the wiki. It would be nice to organize that, and part of that is understanding
the scope.
- What is the relationship between the docs & the wiki?
- [Hugo] The old info is not useful, but people are still updating the wiki and adding
useful info.
- Info in the docs should not be duplicated in the wiki. We should avoid linking to
the wiki; if we do link we should be explicit that this is a community-maintained
wiki.
- [Carol] I know that some people like the wiki, but it's not a good place for project
documentation.
- [Keith] From the education & outreach perspective & former Python subredditor &
Python Discord mod: people who find the wiki very quickly get to outdated
information. We want to change that.
- Moving wiki to Git is an interesting idea, but takes a lot of work. If we start
updating, people will start saying “my resource should be here too”
- [Carol] audited the python.org & links two levels from Documentation, made sure
links to official docs are first, then educational resources, then the wiki. It
shouldn't be the first place people go to for information.
- [Keith] Is the audit publicly available? What is a good format to make an audit, so
we can share actionable information?
- [Carol] can share that with Keith & Elena
- [Keith] What's a good format? How do we avoid duplicating work and move to some
version of “better”?
- [Carol] Start at the homepage, see where the links lead
- From the history, it's best to approach it as an external resource. That is in some
ways how it's been managed. From an education point of view, it would be good to get
the homepage to the point where it would be good for new contributors.
- [Maciek] On Wikipedia, they use bots to add “this is outdated” banners. Should we
try to do that? Add banners for up-to-date content, redirects to newer resources for
outdated info?
- [Hugo] The wiki will be updated to new MoinMoin soon, let's not do automation now.
- Some news sites have also been adding banners for older articles.
- [Keith] How would you define wiki content that should be moved to docs.python.org?
- [Hugo] d.p.o is mainly focused on the tutorial and reference guide; it should fit
there.
- [Carol] Historical information -- something Guido or Barry wrote early on to give
context -- we should move that as well. Perhaps not to docs.python.org, but
somewhere else under python.org.
- [Ryan] Diátaxis says what should go in docs; if it's not in one of the categories it
should not go in docs.
- [Keith] Lots of good things to talk about; I don't know what my conclusion will be
- [Carol] It would be great if the Education & Outreach Workgroup makes a landing
page, perhaps with content from the wiki.
- [Keith] That's the end goal

- [Hugo] Any news from the EB?

- [Carol] They have met, I've missed a few meetings. Will meet next week, maybe we can
put something public up. There are plans to audit of some of the docs.

- [Hugo] We're using the latest version of Sphinx for latest version of the docs and the
bugfix versions. Previously we limited this to what various distributors use. That
also means that if we need something new in the docs, we can add it to Sphinx
relatively quickly.

- [Maciek] Translation dashboard: we started to track the change in last 30 days; it's
shown with a different colour.

- Sphinx build warnings and lint errors are in progress.

- [Hugo] Ryan, you made some PRs, are they getting reviews?
- [Ryan] Going great!

## 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.
1 change: 1 addition & 0 deletions docs/monthly-meeting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,4 @@ Monthly reports in chronological order.
Dec 2024 <2024-12.md>
Jan 2025 <2025-01.md>
Feb 2025 <2025-02.md>
Mar 2025 <2025-03.md>