|
| 1 | +# Documentation Community Team Meeting (August 2023) |
| 2 | + |
| 3 | +- **Date:** 2023-08-01 |
| 4 | +- **Time:** [19:00 UTC](https://arewemeetingyet.com/UTC/2023-08-01/19:00/Docs%20Meeting) |
| 5 | +- **This HackMD:** https://hackmd.io/@encukou/pydocswg1 |
| 6 | +- [**Discourse thread**](https://discuss.python.org/t/30549) (for August) |
| 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` / Discord if different) |
| 20 | +- Hugo van Kemenade / `@hugovk` |
| 21 | +- Daniele Procida |
| 22 | +- Manuel Kaufmann / `@humitos` |
| 23 | +- Ryan Duve / `@ryan-duve` |
| 24 | +- C.A.M. Gerlach / `@CAM-Gerlach` |
| 25 | +- Petr Viktorin / `@encukou` |
| 26 | +- Marcus Sherman / `@betteridiot` |
| 27 | +- Joe Kaufeld / `@itsthejoker` |
| 28 | + |
| 29 | + |
| 30 | +## Reports and celebrations |
| 31 | + |
| 32 | +- [PR to keep "translated" attribute on translated nodes](https://github.com/sphinx-doc/sphinx/pull/11502) landed and released! :tada: |
| 33 | + - https://github.com/python/docsbuild-scripts/issues/148#issuecomment-1648836409 has the details on how it's exposed! |
| 34 | + |
| 35 | +- [Hugo] CPython sprint at EuroPython: we had one room for code and another for documentation, and merged some 140 PRs in total! Thanks to Daniele for helping out and all the excellent docs advice! (Photos: https://mastodon.social/@hugovk/110792652209141428) |
| 36 | + |
| 37 | + |
| 38 | +## Discussion |
| 39 | + |
| 40 | +- Should we set up [Trusted Publishers](https://docs.pypi.org/trusted-publishers/using-a-publisher/) on python-docs-theme? |
| 41 | + - Pradyun will file an issue |
| 42 | + |
| 43 | +- [Hugo] Plausible trial update |
| 44 | + - Public Dashboard [link expired] |
| 45 | + - Would be too expensive to pay for hosted version |
| 46 | + - Should be easy to host it ourselves on PSF infra |
| 47 | + - Next step: |
| 48 | + - Ask PSF/Ee if we want to self-host, or pay for the service (or get sponsored) |
| 49 | + - Let the SC look at the dashboard |
| 50 | + |
| 51 | +- [Hugo] Dark theme deploy: 3.11 RM Pablo said fine to deploy. To deploy, need to merge [python/docsbuild-scripts#161](https://github.com/python/docsbuild-scripts/pull/161) and/or pin in `requirements.txt` |
| 52 | + |
| 53 | +- [CAM] Update on structured deprecation work |
| 54 | + - Originaly prompted by [a recent Discourse thread on soft deprecations](https://discuss.python.org/t/formalize-the-concept-of-soft-deprecation-dont-schedule-removal-in-pep-387-backwards-compatibility-policy/27957/73) |
| 55 | + - Went through many iterations of design and testing on examples |
| 56 | + - Wrote up a [detailed design doc](https://hackmd.io/@CAM-Gerlach/BJuLFRLj2) with: |
| 57 | + - Rationale and benefits |
| 58 | + - Phased implementation plan |
| 59 | + - Directive input schema |
| 60 | + - JSON, etc. output schema |
| 61 | + - Worked through examples |
| 62 | + - Open questions and additional notes |
| 63 | + - Initial implementation currently in progress; should have a final |
| 64 | + |
| 65 | +- [Daniele] On-going documentation commit approaches |
| 66 | + - suggest changing approach to docs PRs |
| 67 | + - Often a PR will make docs look *worse* -- highlight what needs to be changed |
| 68 | + - docs no longer need to target only "graybeards", but also many new "non-programmers" |
| 69 | + - [CAM] Maybe also discussion of the [Porting Guide PR](https://github.com/python/cpython/pull/107434) as an application of this? |
| 70 | + - Maybe mark documents as historical? |
| 71 | + - Forward plan: Merge Daniele's PR and open an issue for a followup to remove/update more outdated content |
| 72 | + |
| 73 | + |
| 74 | +## Next meeting |
| 75 | + |
| 76 | +The docs team generally meets on the first Tuesday of every month. |
| 77 | + |
| 78 | +We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you. |
0 commit comments