Skip to content

Commit 83fb3e3

Browse files
encukouhugovkCAM-Gerlach
authored
Add notes from May (#80)
Co-authored-by: Hugo van Kemenade <[email protected]> Co-authored-by: C.A.M. Gerlach <[email protected]>
1 parent f0226b8 commit 83fb3e3

File tree

2 files changed

+116
-0
lines changed

2 files changed

+116
-0
lines changed

docs/monthly-meeting/2023-05.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Documentation Community Team Meeting (May 2023)
2+
3+
- **Date:** 2023-05-01
4+
- **Time:** [19:00 UTC](https://arewemeetingyet.com/UTC/2023-05-01/19:00/Docs%20Meeting)
5+
- **This HackMD:** https://hackmd.io/@encukou/pydocswg1
6+
- [**Discourse thread**](https://discuss.python.org/t/26182) (for May)
7+
- [**Meeting reports**](https://docs-community.readthedocs.io/en/latest/monthly-meeting/index.html) (the latest one might be an [**unmerged PR**](https://github.com/python/docs-community/pulls))
8+
- **Calendar event:** (send your e-mail to Mariatta for an invitation)
9+
- **How to participate:**
10+
- Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) and ask to be let in.
11+
- 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).
12+
13+
By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/).
14+
Please take a second to read through it!
15+
16+
17+
## Roll call
18+
19+
(Name / `@GitHubUsername`)
20+
- Mariatta `@Mariatta`
21+
- Petr Viktorin `@encukou`
22+
- Cristián Maureira-Fredes `@cmaureir`
23+
- Hugo van Kemenade`@hugovk`
24+
- Jim DeLaHunt `@JDLH`
25+
- Ryan Duve `@ryan-duve`
26+
- Joanna Jablonski `@jablonskidev`
27+
- Ezio Melotti `@ezio-melotti`
28+
- Keto Zhang `@ketozhang`
29+
- Manuel Kaufmann `@humitos`
30+
- Ned Batchelder `@nedbat`
31+
- C.A.M. Gerlach `@CAM-Gerlach`
32+
- Marcus Sherman `@betteridiot`
33+
- Yaa Nuamah Kusi-Fordjour
34+
35+
36+
## Introductions
37+
38+
- Petr, Python core dev, runs these meetings
39+
- Mariatta, one of the people who started the Docs group. Just chaired Pycon US
40+
- Hugo, from Helsinki, Python core dev
41+
- Ryan Duve, data scientist, Python user interested helping with community docs stuff
42+
- Joanna, Python education
43+
- Jim, from Vancouver, Canada; reads docs & fixes things he notices
44+
- Manuel Kaufmann from Argentina now in Spain, translations, Read the Docs, CPython translation in Spanish, PSF Fellow
45+
- Marcus Sherman, from Portland, Maine @ Northeastern University, `@betteridiot`, biologist by training
46+
- Ned, from Boston, made the docs official, eager to see this group grow into a large & welcoming community
47+
- Cristián Maureira-Fredes, CPython Spanish translation
48+
- Keto Zhang, software engineer in astronomy, went to Cam's talk at PyCon
49+
- CAM, gave the talk at PyCon, new Python core dev, from Huntsville, Alabama, Spyder maintainer, looking to be a full-time open-source dev & documentarian
50+
- Ezio, core Dev, working on docs and infrastructure
51+
52+
53+
## Reports and celebrations
54+
55+
Congrats to CAM!
56+
57+
Congrats Ned for the [keynote at PyCon US 2023](https://us.pycon.org/2023/about/keynote-speakers/#ned-batchelder)
58+
59+
60+
* [PyCon](https://us.pycon.org/2023/), April 19-27 2023:
61+
* CAM & Erlend's talk, "[Iteration toward Transformation of the Python Documentation](https://us.pycon.org/2023/schedule/presentation/88/)", went well, good discussions afterwards and many joined the Discord wanting to contribute
62+
* Sprints: some docs contributors, including people making their very first CPython contribution
63+
* Sprints: [Hugo] switched CPython docs previews from Netlify to RtD.
64+
* Main benefit: multiple admins instead of single-person bottleneck with Netlify.
65+
* [python/cpython#103843](https://github.com/python/cpython/pull/103843)
66+
* GH action to update the link from the PR - we don't need one for Netlify
67+
* [JDLH thinks this means] GitHub action to update a link to a documentation preview on ReadTheDocs from the Github Pull Request page. We don't need such a preview for the current docs as published at Netlify.
68+
* Example of preview link: Pull Request [#104013, **gh-104010: Separate and improve docs for typing.get_origin and typing.get_args**](https://github.com/python/cpython/pull/104013), contains a link to a preview of the documentation reflecting the Pull Request's effects, at [https://cpython-previews--104013.org.readthedocs.build/en/104013/](https://cpython-previews--104013.org.readthedocs.build/en/104013/).
69+
* For moving main docs, a few more things are needed, but they're tracked at the RtD side
70+
* We're using a personal account (Mariatta's). Not ideal. Right now community version of RtD doesn't support multiple owners, there are workarounds. Organizations are only in the commercial version so far.
71+
* would be nice to have an ORG account.
72+
* curious about workflow for translations, etc how to migrate the docs translations and the multi-version support to readthedocs
73+
* Manuel set up [python-docs-es.readthedocs.io, the Spanish translation](https://python-docs-es.readthedocs.io/es/3.11/) on RtD. The source files aren't in the translation repo, so the English version is added as a submodule. Translations need to be added as a new project, then connected in the admin interface.
74+
* For multiversion, the version switcher is injected on the bottom right. Each version is a branch or a tag, once enabled they get built.
75+
* That said, RtD is rebuilding the flyout (switcher) to make it easier to customize. Working together with Pradyun (Furo, Lutra)
76+
77+
* The “this is only a preview” header is missing.
78+
79+
## Discussion
80+
81+
* Building images with [mermaid.js](https://mermaid.js.org/) / [mermaid-cli](https://github.com/mermaid-js/mermaid-cli).
82+
- @tysonclugg is trying to put together docs on concurrency which would benefit from good diagrams
83+
- Some other tool to explore?
84+
85+
* [Hugo] PEPs infra: PR opened to improve text readability / page performance:
86+
[python/peps#3132](https://github.com/python/peps/pull/3132)
87+
88+
* [Ned] Best entry point to working on docs, for people newly interested in helping?
89+
- we need clear onboarding
90+
- do we have style guide?
91+
- Cristian: In the python-docs-es team we have [a page inside the docs](https://python-docs-es.readthedocs.io/es/3.11/CONTRIBUTING.html) (docs-ception) that teaches the whole process
92+
- how do we write such docs?
93+
- HackMD or Google Docs
94+
- [Python Docs Community web page](https://docs-community.readthedocs.io/en/latest/)
95+
- source: [github.com/python/docs-community](https://github.com/python/docs-community) e.g. front page source: [docs-community/docs/index.rst](https://github.com/python/docs-community/blob/main/docs/index.rst)
96+
- start having better landing page for Docs there
97+
- The landing page should point to where the conversations happen, e.g. the Discourse server. For a group of translators, a Telegram group is the conversation place. A conversation place helps people support each other.
98+
- [Docs Community Contributing Guide](https://docs-community.readthedocs.io/en/latest/community/contributing.html)
99+
100+
- Translation group
101+
- how to coordinate with the wider translations group, share tips, etc
102+
- Manuel: started 3 years ago: have a place to connect with other translators and resources
103+
- Julien introduced the tools for translation.
104+
- Create channel for translations
105+
- Cristian: It also could be a good idea to have in the main Documentation page (that we will have soon) something like "Wanna help with a translation of these docs? check out this initiatives <list of languages here>"
106+
- Ezio: I already brought it up a couple of times, but it would be good to unify the translation infrastructure and tools (see e.g. [python/python-docs-zh-tw#399](https://github.com/python/python-docs-zh-tw/issues/399))
107+
108+
109+
110+
## Next meeting
111+
112+
The docs team generally meets on the first Monday of every month.
113+
114+
We have a recurring Google Calendar event for the meeting.
115+
Let Mariatta know your email address and she can invite you.

docs/monthly-meeting/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,4 @@ Monthly reports in reverse chronological order.
2626
Feb 2023 <2023-02.md>
2727
Mar 2023 <2023-03.md>
2828
Apr 2023 <2023-04.md>
29+
May 2023 <2023-05.md>

0 commit comments

Comments
 (0)