Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Hugo van Kemenade <[email protected]>
  • Loading branch information
trallard and hugovk authored Aug 30, 2024
1 parent 5e8b2d6 commit d5b537e
Showing 1 changed file with 11 additions and 29 deletions.
40 changes: 11 additions & 29 deletions docs/monthly-meeting/2024-08.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

- **Date:** 2024-08-06
- **Time:** [19:00 UTC](https://arewemeetingyet.com/UTC/2024-08-06/19:00/Docs%20Meeting)
- **This HackMD:** https://hackmd.io/@encukou/pydocswg1
- [**Discourse thread**](TODO) (for August)
- **This HackMD:** <https://hackmd.io/@encukou/pydocswg1>
- [**Discourse thread**](https://discuss.python.org/t/documentation-community-meeting-tuesday-6th-august-2024/59599) (for August)
- [**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:**
Expand All @@ -28,18 +28,8 @@ Please take a second to read through it!
- Carol / `@willingc`
- Daniele / `@EvilDMP`

## Introductions

> If there are any new people, we should do a round of introductions.
## 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.
- [Name] ...

- [Manuel] Moving the docs to Read the Docs
- Several reasons: be more open (let everyone see if the builds failed, how the builds work); faster builds;
- A test is already working for pull requests. Only PRs that touch documentation are built.
Expand All @@ -51,26 +41,26 @@ Please take a second to read through it!
- [Trey] Will this enhance the search? [Manuel] There have been many improvements in RTD search lately. Traditionally RTD overwrites Sphinx search entirely with server-side (Elastic Search) search. Now there's a way to choose RTD or Sphinx search from the docs theme. There's also a person who said they're working on the Sphinx sphinx search engine.
- [Trey] So there won't be a change on day one.
- [Carol] For the PR previews, is there an option to link to the most changed file in the PR? [Manuel] We're working on it, don't know the details. The idea is to perform a diff and determine what changed, and link to it directly.
- Issue: https://github.com/readthedocs/readthedocs.org/issues/11319
- Design doc: https://github.com/readthedocs/readthedocs.org/pull/11507
- Issue: [readthedocs/readthedocs.org#11319](https://github.com/readthedocs/readthedocs.org/issues/11319)
- Design doc:[readthedocs/readthedocs.org#11507](https://github.com/readthedocs/readthedocs.org/pull/11507)
- [Carol] That's way further ahead than I thought.Thank you!

## Discussion

[Ezio] Deprecations in the What's New file - replacing the list of deprecations with a table
- [Hugo] We previously talked about putting deprecations in include files. We have that now: https://docs.python.org/3/deprecations/index.html
- Compare https://pillow.readthedocs.io/en/stable/deprecations.html and https://docs.pytest.org/en/stable/deprecations.html
- [Hugo] We previously talked about putting deprecations in include files. We have that now: <https://docs.python.org/3/deprecations/index.html>
- Compare <https://pillow.readthedocs.io/en/stable/deprecations.html> and <https://docs.pytest.org/en/stable/deprecations.html>
- *Some notes compiled after the meeting:*
- improving deprecation notes: explain how to replace the deprecated API, either in the note, or in a section at the bottom of the module's doc
- duplication: ensure that the deprecation notes only exist in a single place without duplication (links to it and includes in multiple places are fine)
- discoverability: making sure that people can easily find what is being deprecated and removed, and how to fix it
- future-proofing: make sure these info are not completely removed from the latest docs (a link to older versions is fine)
- layout: list vs table (see https://github.com/python/cpython/issues/122652), next step is to create a table as a proof of concept to see what works best
- layout: list vs table (see [python/cpython#122652](https://github.com/python/cpython/issues/122652)), next step is to create a table as a proof of concept to see what works best
- *Some additional links:*
- python-dev thread from a decade ago: https://mail.python.org/pipermail/python-dev/2011-October/114199.html (some of these things are fixed, some are no longer relevant, some still need work)
- Enforcing the use of deprecated-removed: https://github.com/python/cpython/issues/92564
- A related core-workflow issue: https://github.com/python/core-workflow/issues/468
- Moving deprecations into include files: https://github.com/python/cpython/issues/122085
- python-dev thread from a decade ago: <https://mail.python.org/pipermail/python-dev/2011-October/114199.html> (some of these things are fixed, some are no longer relevant, some still need work)
- Enforcing the use of deprecated-removed: [python/cpython#92564](https://github.com/python/cpython/issues/92564)
- A related core-workflow issue: [python/core-workflow#468](https://github.com/python/core-workflow/issues/468)
- Moving deprecations into include files: [python/cpython#122085](https://github.com/python/cpython/issues/122085)
- Next step: add a demo of how the table would look

[Ezio] Defining and documenting a procedure to ensure that we follow up on additional tasks brought up in review
Expand All @@ -82,14 +72,6 @@ Please take a second to read through it!

[#118891 Slow actions for doc builds](https://github.com/python/cpython/issues/118891)

### Python Project Documentation

*Relating to `docs.python.org`, `peps.python.org`, `devguide.python.org`, etc.*

### 'Internal' items

*For and about the Community or Working Group*

### PEP Workflow

- [PEP 750: Tag strings for writing domain specific languages](https://github.com/python/peps/pull/3858) FYI
Expand Down

0 comments on commit d5b537e

Please sign in to comment.