Skip to content

Add notes from the 2022-11 meeting #68

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 14, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 65 additions & 0 deletions docs/monthly-meeting/2022-11.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Documentation Community Team Meeting (November 2022)

- **Date:** 2022-11-07
- **Time:** [19:30 UTC](https://arewemeetingyet.com/UTC/2022-11-07/19:30/Docs%20Meeting)
- **This HackMD:** https://hackmd.io/@encukou/pydocswg1
- [**Discourse thread**](https://discuss.python.org/t/20057) (for November)
- **Calendar event:** (send your e-mail to Mariatta for an invitation)
- **How to participate:**
- Go to [Google Meet](https://meet.google.com/dii-qrzf-wkw) and ask to be let in.
- 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).

By participating in this meeting, you are agreeing to abide by and uphold the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/).
Please take a second to read through it!

## Roll call

- Mariatta / `@mariatta`
- Jim DeLaHunt / @JDLH
- Ezio Melotti / `@ezio-melotti`
- Erlend Aasland / @erlend-aasland
- Hugo van Kemenade / `@hugovk`
- Ned Batchelder / `@nedbat`
- C.A.M. Gerlach / `@CAM-Gerlach`
- Petr Viktorin / `@encukou` (second half)


## Quick updates - Introductions

> 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.

- Mariatta: Python BR keynote
- Jim DeLaHunt: pass
- Ezio: devguide, [CSV with status of Python branches](https://github.com/python/devguide/pull/884), [OpenGraph metadata for devguide et al.](https://github.com/python/devguide/pull/953), catching up after a busy month
- Erlend: getting help from Cam on two huge PRs on SQLite docs
- Hugo: OpenGraph extension on DevGuide, created PR on Sphinx extension to improve SEO, now does `meta description` in addition to `meta og:...`, plus bug fix in `dirhtml` used to generate the pages.
- Cam: attended core dev sprint, helped a lot of people get things done. Will work on whats new. New Sphinx roles for linking Python source code & GitHub. automate checking if things added in new version is documented, docstrings updated, deprecation tracking.

## Agenda items

* (Alex) ["object doesn't have an `__enter__`/`__exit__` yet docs say it does"](https://github.com/python/cpython/issues/97699) might be interesting to discuss

- concern with renaming/changing text will break links (specifically, fragment parts of URL e.g. `#object.__enter__`).
- it's better to add a paragraph above explaining it. even though readers may not read the paragraph, at least we can still point people to it, instead of breaking links.


- Infrastructure & detecting/avoiding broken links
- how to get visibility of docs traffic and broken url hits?
- First step: ask [#PSF category on Discourse](https://discuss.python.org/c/python-software-foundation/9).
- Done, see [Discourse thread](https://discuss.python.org/t/data-on-requests-for-missing-urls-in-docs-python-org-etc/20841) —JDLH
- Probably Ee [@EWDurbin](https://discuss.python.org/u/ewdurbin/summary) oversees this, but better not to start there, Ee is busy.
- need help from Ee about docs preview on Netlify
- [`sphinxext-rediraffe`](https://sphinxext-rediraffe.readthedocs.io/en/latest/) can check at the source level
* (Hugo) [Add release cycle chart to docs](https://github.com/python/docs-community/issues/67)
* **Ezio**: fix conflicts in [python/devguide#884](https://github.com/python/devguide/pull/884)
* Then, merge the chart generation

## Discussion

### 'Internal' items

*For and about the Community or Working Group*

- Better time slot for the meeting
- Maybe let's alternate the Monday slot with another time, so other ppl can join?
- **CAM** to start a poll for a good time slot. ([Poll now live](https://whenisgood.net/pydocs-team/v3))
1 change: 1 addition & 0 deletions docs/monthly-meeting/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,4 @@ Monthly reports in reverse chronological order.
Aug 2022 <2022-08.md>
Sep 2022 <2022-09.md>
Oct 2022 <2022-10.md>
Nov 2022 <2022-11.md>