From b30f2fc14ad75a6e1d65fbad77231fdb65b48375 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:27:11 +0200 Subject: [PATCH 1/5] Add codespell to pre-commit and CI --- .codespellrc | 2 ++ .github/workflows/lint.yaml | 7 +++++++ .pre-commit-config.yaml | 11 ++++++++--- 3 files changed, 17 insertions(+), 3 deletions(-) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..4680d04 --- /dev/null +++ b/.codespellrc @@ -0,0 +1,2 @@ +[codespell] +ignore-words-list = Ege, Ned diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index ae3fcf4..ff9d045 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index fb6d8ad..1eb71c5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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 @@ -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 From 96e23e5453531d5787e6423ccabe80362ebe68ab Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:42:56 +0200 Subject: [PATCH 2/5] Add March 2025 meeting notes --- docs/monthly-meeting/2025-03.md | 144 ++++++++++++++++++++++++++++++++ docs/monthly-meeting/index.rst | 1 + 2 files changed, 145 insertions(+) create mode 100644 docs/monthly-meeting/2025-03.md diff --git a/docs/monthly-meeting/2025-03.md b/docs/monthly-meeting/2025-03.md new file mode 100644 index 0000000..1b23bd1 --- /dev/null +++ b/docs/monthly-meeting/2025-03.md @@ -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:** +- [**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: + + - 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's been an 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. diff --git a/docs/monthly-meeting/index.rst b/docs/monthly-meeting/index.rst index 5c61c53..bb83989 100644 --- a/docs/monthly-meeting/index.rst +++ b/docs/monthly-meeting/index.rst @@ -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> From 3adad03e84acafa2d12ce89ad706367c6e464570 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:47:55 +0200 Subject: [PATCH 3/5] Fix linkcheck --- docs/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index 8833bcd..9700ff8 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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: From 67472237aa44500ed3af2109bbcc1e24eb0f8f51 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 5 Mar 2025 18:54:17 +0200 Subject: [PATCH 4/5] Fix linkcheck --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 9700ff8..6560cf7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -56,7 +56,7 @@ r"https://github.com.+?#.*", r"https://hackmd\.io/[^?]+\?[^#]+#.+", # Google Meet gives 404 - r"https://meet.google.com/.*" + 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: From 6da23c766177fd5b552fb40a0ad9f5f0e69ef12c Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> Date: Wed, 5 Mar 2025 21:24:23 +0200 Subject: [PATCH 5/5] Update docs/monthly-meeting/2025-03.md Co-authored-by: Carol Willing --- docs/monthly-meeting/2025-03.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/monthly-meeting/2025-03.md b/docs/monthly-meeting/2025-03.md index 1b23bd1..44bcebd 100644 --- a/docs/monthly-meeting/2025-03.md +++ b/docs/monthly-meeting/2025-03.md @@ -121,7 +121,7 @@ None this time. - [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's been an audit of some of the docs [?]. + 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