Skip to content

Commit 5e0c9e7

Browse files
StanFromIrelandStanFromIreland
committed
Commit
1 parent 9a45899 commit 5e0c9e7

File tree

2 files changed

+165
-0
lines changed

2 files changed

+165
-0
lines changed

‎docs/monthly-meeting/2025-09.md‎

Lines changed: 164 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,164 @@
1+
# Documentation Community Team Meeting (September 2, 2025)
2+
3+
## Roll call
4+
5+
(Name / `@GitHubUsername` *[/ Discord, if different]*)
6+
7+
- Ryan Duve / `@ryan-duve`
8+
- Hugo van Kemenade / `@hugovk`
9+
- Carol Willing / `@willingc`
10+
- Adam Turner / `@AA-Turner`
11+
- Lufti Zuchri
12+
- Irvan Putra / `irvan-putra` / `irvan.putra`
13+
- Jacob Coffee / `@JacobCoffee`
14+
- Stan Ulbrych / `@StanFromIreland`
15+
16+
17+
## Discussion
18+
19+
- [Hugo] What's the latest on the language mix-up? Do we know any translations
20+
that still have the wrong language? Are there remaining languages that need
21+
updating and CI unpausing?
22+
23+
- [Adam] At least Japanese not yet unpaused. No update on
24+
[python-docs-translations/transifex-automations#155](https://github.com/python-docs-translations/transifex-automations/issues/155).
25+
26+
- [Hugo] Let's follow up on Discord.
27+
28+
- [Carol] Let's have an hour session at the core sprint in two weeks so we all
29+
understand the workflow.
30+
31+
- [Petr] Paid Transifex plan for translations: [python/steering-council#297](https://github.com/python/steering-council/issues/297)
32+
33+
- [Hugo] Transifex is approved for one year. How can we evaluate its use towards the end of the year?
34+
35+
- [Hugo] Pycon Greece had a good talk. Not using any web tools.
36+
Teaching people how to use Git/GitHub and get involved in open source.
37+
Spanish is similar.
38+
39+
**Action: Hugo to share link**
40+
41+
- [Adam] Also evaluated Weblate, it was around 5% less, but would involve
42+
migrating all translations to a new platform, with added social cost.
43+
44+
- [Carol] Suggests that by the end of the year evaluate CIs, and by PyCon US
45+
evaluate if there are improvements for users, are they finding value,
46+
and in what. Compare paid vs. unpaid. Gives us another quarter to evaluate
47+
whether to go back to unpaid.
48+
49+
- [Adam] Yes, each team has been working independently. There are benefits of
50+
translating with similar tools and tech, for reducing workload and sharing
51+
things. For teams that are currently using Transifex, hope we can evaluate
52+
and see if we can bring in other teams to see if Transifex helps them.
53+
54+
- [Carol] Lysandros from the Greek team spoke at the last Language Summit
55+
about it and how to come up with best practices.
56+
57+
- [Adam] Stan's recent split in the devguide really helped.
58+
59+
- [Indonesian docs coordinators] We're trying to work out how to add a workflow
60+
to support contributions via both Transifex and GitHub. Have any other
61+
communities done this, or does it tend to be an all or nothing approach with Transifex?
62+
63+
- [Stan] This has not been done yet, successfully.
64+
65+
- [Lufti] Cannot sync two ways. What's the best practice?
66+
67+
- [Stan] No existing solution - will need to set up a workflow, but could cause problems.
68+
69+
- [Lufti] Not mandatory, so can do own thing for now.
70+
71+
- [Stan] [Transifex documentation](https://developers.transifex.com/docs/cli) describes commands for pushing translations
72+
73+
- [Irvan] When adding new translators, 50% like to use GitHub, and 50% like to use Transifex.
74+
Those using Transifex are not communicating with others.
75+
User experience at Transifex is not that good, but still looking to use.
76+
Haven't decided which approach yet.
77+
The diff conflicts if people modify the same file in different places.
78+
79+
- [Stan] To contact translators on Transifex, you can use the [built-in forum](https://app.transifex.com/python-doc/teams/5390/discussions/)
80+
81+
- [Hugo] Recommends using just GitHub or Transifex.
82+
Recommends coordinators decide which works best for them, can include the
83+
translation team, but coordinators decide.
84+
Then they communicate it to the team.
85+
Find a way of communicating that works, maybe the forum Stan mentions,
86+
or ML, or Discord, or whatever.
87+
We can create a dedicated channel if needed.
88+
89+
- [Irvan] Someone just joined Transifex and contributed, we don't know who they are.
90+
91+
- [Stan] This is also a benefit of TX, it advertises the project for us.
92+
There are many people who translate open source projects on the platform.
93+
94+
95+
- [Hugo] [Removing non-HTML (PDF, EPUB, etc) documentation downloads](https://discuss.python.org/t/removing-non-html-pdf-epub-etc-documentation-downloads/101343)
96+
97+
120 voters:
98+
99+
| Option | Percentage |
100+
|--------------------------------------------------|------------|
101+
| I don’t care / I only use HTML / show results | 47% |
102+
| Remove all non-HTML downloads | 36% |
103+
| Keep the status quo (HTML, PDF, EPUB, and so on) | 12% |
104+
| Remove PDF downloads | 5% |
105+
| I don’t read/use Python’s documentation | 0% |
106+
107+
If we bucket the top result as happy to remove any non-HTML
108+
(because there's a separate button to show results):
109+
110+
| Option | Percentage |
111+
|--------------------------------------------------|------------|
112+
| Remove all non-HTML downloads | 87% |
113+
| Remove PDF downloads | 52% |
114+
| Keep the status quo (HTML, PDF, EPUB, and so on) | 12% |
115+
116+
- [Adam] Thinks we should discount the 47%.
117+
Reticent to entirely remove PDF because there have been notionally valid use
118+
cases, although skeptical of some — some said the PDF is a single file, but it's not.
119+
Don't want to remove and cause unnecessary harm.
120+
By far PDF is the biggest drain. The other one is for emacs.
121+
From a resource perspective, I would like to remove them. But I am in two minds.
122+
Releases also include these docs.
123+
Find most docs bugs normal build, don't want to run into those on release day.
124+
125+
- [Carol] Could see PDF or EPUB being useful in certain circumstances.
126+
Is it ok just to build it when something is released? To not do backports on them?
127+
In the science world, many have been dropping PDFs as they are time-consuming
128+
and a pain.
129+
For the dev branch, maybe build nightly or what the Release Manager thinks
130+
is most useful.
131+
132+
- [Adam] Now built three times per month. PDF and EPUB are kind of similar,
133+
EPUB is much simpler, it is a load of XHTML in a zip, and takes like two mins.
134+
PDF is hours for latex stuff. Potentially drop it, and 3.15 or 3.16 will have
135+
no PDFs, and we can see if people complain. If genuinely useful in places
136+
with worse internet, don't want to force people to create environments for
137+
PDF generation — it's not easy.
138+
139+
- [Adam] Suggestion: for beta, turn off PDF for what will become 3.16.
140+
If we are to announce now, that's at least six months of lead time.
141+
Don't know if we are overthinking the fallout of doing it.
142+
Discourse/poll is populated by very online people and is not going to capture real users.
143+
144+
**ACTION: hook up plausible to downloads**
145+
146+
- [Jacob] Docs nightly load avg has started causing outages ~nightly around
147+
01:00CST (~0500,0600 UTC). Would like to work with someone to remediate.
148+
Shared in Datadog with those that had accounts available (Adam, Hugo, Carol).
149+
Started on Aug. 5th, continues sporadically (sometimes every 2 days, sometimes 9 days.)
150+
151+
- [Hugo]+[Adam] Will help.
152+
153+
154+
- [Adam] discussion about splitting pages. Any opposition to just starting with
155+
simpler, standalone sections? Had a start a couple of times, never gotten to the PR stage.
156+
157+
- [Carol] Do we have a list of target pages?
158+
159+
- [Adam] Going by longest pages. Start with stdtypes and functions.
160+
For example, could move all the string methods to their own page.
161+
162+
- [Adam] Long ones: datamodel, typing, logging cookbook, and so on.
163+
164+
- [Carol] Maybe logging cookbook could be a good start?

‎docs/monthly-meeting/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,4 @@ Monthly reports in chronological order.
2525
Jun 2025 <2025-06.md>
2626
Jul 2025 <2025-07.md>
2727
Aug 2025 <2025-08.md>
28+
Sep 2025 <2025-09.md>

0 commit comments

Comments
 (0)