|
| 1 | +# Documentation Community Team Meeting (July 2024) |
| 2 | + |
| 3 | +- **Date:** 2024-07-02 |
| 4 | +- **Time:** [19:00 UTC](https://arewemeetingyet.com/UTC/2024-07-02/19:00/Docs%20Meeting) |
| 5 | +- **This HackMD:** [https://hackmd.io/@encukou/pydocswg1](https://hackmd.io/@encukou/pydocswg1) |
| 6 | +- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-2nd-july-2024/56629) (for July) |
| 7 | +- [**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)) |
| 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` *[/ Discord, if different]*) |
| 20 | + |
| 21 | +- Daniele Procida `@danieleprocida` |
| 22 | +- Carol / `@willingc` |
| 23 | +- Ned Batchelder / `@nedbat` |
| 24 | +- Ezio Melotti / `@ezio-melotti` |
| 25 | +- Petr Viktorin / `@encukou` |
| 26 | +- Jim DeLaHunt / `@JDLH` |
| 27 | +- Ryan / `ryan-duve` |
| 28 | +- Hugo van Kemenade / `@hugovk` |
| 29 | +- Trey |
| 30 | + |
| 31 | +## Introductions |
| 32 | + |
| 33 | +> If there are any new people, we should do a round of introductions. |
| 34 | +
|
| 35 | + |
| 36 | + |
| 37 | +## Reports and celebrations |
| 38 | + |
| 39 | +> 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. |
| 40 | +
|
| 41 | +> 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. |
| 42 | +
|
| 43 | +- [Hugo] Plausible stats are live! |
| 44 | + [plausible.io/docs.python.org](https://plausible.io/docs.python.org) & |
| 45 | + [plausible.io/packaging.python.org](https://plausible.io/packaging.python.org) |
| 46 | + |
| 47 | +- [Hugo] Sphinx meetup tomorrow at 20 UTC: |
| 48 | + [sphinx-doc/discussions/12443](https://github.com/orgs/sphinx-doc/discussions/12443#discussioncomment-9936592) |
| 49 | + |
| 50 | +## Discussion |
| 51 | + |
| 52 | +- [Daniele] Options for hosting a Python documentation sprint |
| 53 | + (Cardiff or London, possibly Netherlands) |
| 54 | + - Daniele ran a successful docs sprint @ DjangoCon. |
| 55 | + - People choose anything that bothers you in the docs, determine the rule it |
| 56 | + breaks, choose what you'd do right now to fix it. Daniele can "bless" the |
| 57 | + idea, or not; if blessed the person can work on it. |
| 58 | + - Some commits made it into the docs |
| 59 | + - Daniele can arrange a sprint in one of the 3 locations |
| 60 | + - [Ned] A sprint doesn't have to be a big formal thing; it can be a meetup |
| 61 | + - [Daniele] Some formal structure helped |
| 62 | + - [Ned] You don't need special permission |
| 63 | + - [Daniele] Would a core dev be interested in joining? |
| 64 | + - Possibly: Alex, Pradyun, Tania Allard, Petr |
| 65 | + - [Hugo] Last year Daniele led the workshop & Hugo was clicking the merge |
| 66 | + button at the sprint, worked very well |
| 67 | + - [Petr] worried about the conference helping to get people to the event |
| 68 | + - [Carol] The [packaging guide (Python Packaging User Guide)](https://packaging.python.org/en/latest/) |
| 69 | + could also use some work |
| 70 | + - [Ned] interested in the idea spreadsheet; maybe it can help even offline |
| 71 | + - [Carol] At last PyCon US, Shauna and Melanie tried to make their first docs |
| 72 | + PR, and found some issues in the onboarding process |
| 73 | + - Shauna: https://docs.google.com/document/d/1icjPpmEUH0BRPDwl7oXLkpasvwZoS5io2LyTEhblku0/edit |
| 74 | + - Melanie: https://docs.google.com/document/d/11zxisx5XfYOsrDOn4qd-XUSpDltIOi35qiOO9fDLfnI/edit |
| 75 | + |
| 76 | +### Python Project Documentation |
| 77 | + |
| 78 | +*Relating to `docs.python.org`, `peps.python.org`, `devguide.python.org`, etc.* |
| 79 | + |
| 80 | +- [Ryan] I need to load JSON with NaN values. |
| 81 | + [The official documentation](https://docs.python.org/3/library/json.html#json.load) says: |
| 82 | + > **parse_constant**, if specified, will be called with one of the following strings: |
| 83 | + > `'-Infinity'`, `'Infinity'`, `'NaN'`. This can be used to raise an exception if |
| 84 | + invalid JSON numbers are encountered. |
| 85 | + - I could not tell how to use this, or even if it is what I needed, until I |
| 86 | + Googled it and |
| 87 | + [found this example on Stack Overflow](https://stackoverflow.com/a/62685520). |
| 88 | + - As a user, I intend to open a thread on Discourse before making a PR. But |
| 89 | + is there a more open conversation we should have about examples within |
| 90 | + documentation for docs.python.org, first? |
| 91 | + - You don't need a discussion; file an issue and send a PR. |
| 92 | + |
| 93 | +- [Hugo] Re: avoiding duplicate deprecations across What's New files: |
| 94 | + [Discourse](https://discuss.python.org/t/streamline-whats-new-by-moving-deprecations-and-removals-out-of-news/53997) |
| 95 | + - PR [python/cpython#121241](https://github.com/python/cpython/pull/121241) |
| 96 | + makes a start by moving pending removals from "What's New in 3.13" into |
| 97 | + includes |
| 98 | + |
| 99 | +- [Petr] `.. versionadded:: next`: |
| 100 | + [python/cpython#121277](https://github.com/python/cpython/issues/121277) |
| 101 | + |
| 102 | +- [Ned] Positional-only arguments: |
| 103 | + [python/cpython#121197](https://github.com/python/cpython/pull/121197) |
| 104 | + - What needs EB pronouncement |
| 105 | + - Can we help people understand terse punctuation? |
| 106 | + - add a tooltip? That won't work on mobile & screen readers |
| 107 | + - still better than nothing for non-mobile users |
| 108 | + - make it a link? |
| 109 | + - first make sure there's a good place to link to |
| 110 | + - make sure [searching for `/`](https://docs.python.org/3/search.html?q=%2F) |
| 111 | + gets you to the right place? |
| 112 | + - [Daniele] Documentation on how to read the documentation isn't good |
| 113 | + - Ned to write this down |
| 114 | + - PR: https://github.com/python/devguide/pull/1344 |
| 115 | + |
| 116 | +## Next meeting |
| 117 | + |
| 118 | +The docs team generally meets on the first Tuesday of every month around 19:00-ish UTC. |
| 119 | + |
| 120 | +We have a recurring Google Calendar event for the meeting. |
| 121 | +Let Mariatta know your email address and she can invite you. |
0 commit comments