Skip to content

Commit

Permalink
Make links clickable in 2022 minutes (#125)
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovk authored Jul 31, 2024
1 parent 0ee04a3 commit 90923f6
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 65 deletions.
48 changes: 24 additions & 24 deletions docs/monthly-meeting/2022-02.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ On the first meeting, let's use this slot for an introduction!
## Roll call:

- [name] / affiliation / github username
- [Pradyun] / :shrug: / @pradyunsg
- [Pradyun] / 🤷 / @pradyunsg
- [willingc] / Core Dev / willingc
- [Ned] / edX, Open edX, Boston Python, Coverage.py / @nedbat
- James
Expand All @@ -35,15 +35,15 @@ On the first meeting, let's use this slot for an introduction!

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.

- Welcome Documentarians :smile:
- Welcome Documentarians 😀

> TIL about HackMD's `[name=Pradyun]` syntax, and it's great! [Pradyun]
>
>> editor's note: it doesn't work outside HackMD, and has been replaced by [name] in this document
> I've been making a decent amount of progress on the Sphinx theme, and spent some time reading the implementation of https://github.com/python/docsbuild-scripts [Pradyun]
> I've been making a decent amount of progress on the Sphinx theme, and spent some time reading the implementation of [python/docsbuild-scripts](https://github.com/python/docsbuild-scripts) [Pradyun]
> Thanks @encukou for kicking this off. :tada: [willingc]
> Thanks @encukou for kicking this off. 🎉 [willingc]
## Agenda items

Expand Down Expand Up @@ -74,7 +74,7 @@ A "guidance document is at the end of the document"

[Ned] Right, writing rules shouldn't block our work. But how do we determine a PR is good? Having guidance up front is a good way not only to avoid conflict, but also guide people doing the work.

[James] Example: someone was confused print returns None (ref: https://bugs.python.org/issue46282). Let's add it to the builtins page! But someone said it wouldn't be appropriate to add return value to all the builtins.
[James] Example: someone was confused print returns None (ref: [python/cpython#90440](https://github.com/python/cpython/issues/90440)). Let's add it to the builtins page! But someone said it wouldn't be appropriate to add return value to all the builtins.
Guidance, like dividing docs into 4 quadrants, would help.

[CAM] From experience maintaining the Spyder docs, it's finding the right balance between guidelines for consistency + better onboarding, and the pragmatic aspects of avoiding nit-picking -- focusing on the more important aspects like clarity.
Expand Down Expand Up @@ -127,7 +127,7 @@ Even if Docs WG is the place where people submit ideas and others implement them

[Ned] Sounds like a good issue to file.

[Petr] Filing an issue. (https://github.com/python/docs-community/issues/17)
[Petr] Filing an issue. ([python/docs-community#17](https://github.com/python/docs-community/issues/17))

[Paul] You can probably blame the CLA process on me.

Expand Down Expand Up @@ -176,24 +176,24 @@ GitHub team under the `python` org? Would have issues with adding people to the

From the issue tracker:

- Migration of theme to modern responsive theme https://github.com/python/docs-community/issues/1
- Migration of theme to modern responsive theme [python/docs-community#1](https://github.com/python/docs-community/issues/1)
> This is coming along, albeit slower than I'd like. I'm resisting the urge to strive for perfect but, also, I'd like to check all the boxes? [Pradyun]
- Post the application process for workgroup members https://github.com/python/docs-community/issues/3
- Enhancing the switchers setup https://github.com/python/docs-community/issues/4
- Post the application process for workgroup members [python/docs-community#3](https://github.com/python/docs-community/issues/3)
- Enhancing the switchers setup [python/docs-community#4](https://github.com/python/docs-community/issues/4)
> This is related to #14. :P [Pradyun]
- ReadTheDocs https://github.com/python/docs-community/issues/5
- Suggestions from Python Language Summit https://github.com/python/docs-community/issues/6
- Mobile friendly theme for wiki.python.org https://github.com/python/docs-community/issues/7
- ReadTheDocs [python/docs-community#5](https://github.com/python/docs-community/issues/5)
- Suggestions from Python Language Summit [python/docs-community#6](https://github.com/python/docs-community/issues/6)
- Mobile friendly theme for wiki.python.org [python/docs-community#7](https://github.com/python/docs-community/issues/7)
> I _think_ a new theme would be nicest, even if it's the most "costly" in terms of effort+time? None of the existing themes look particularly great. [Pradyun]
- Suggestions and ideas from Typing Summit https://github.com/python/docs-community/issues/8
- French translation sprint https://github.com/python/docs-community/issues/9
- Use Sphinx for pep builds and better rendering https://github.com/python/docs-community/issues/10
- Suggestions and ideas from Typing Summit [python/docs-community#8](https://github.com/python/docs-community/issues/8)
- French translation sprint [python/docs-community#9](https://github.com/python/docs-community/issues/9)
- Use Sphinx for pep builds and better rendering [python/docs-community#10](https://github.com/python/docs-community/issues/10)
> This seems to be progressing well mostly thanks to Adam's work; we just need to do some tweaks to the styling and appearance; main blocker is just PEP 676's approval and then getting the infra moved over to whatever we decide on (RTD, GHP, Netlify, etc). A huge improvement and going to unlock a lot of possibilities going forward while being far more maintainable than the hacked-together legacy csystem. I'm a little unsure if this is directly within scope here, though. [CAM-Gerlach]
- Is it in scope? :)
- Having a "fast path" for documentation contributions https://github.com/python/docs-community/issues/13
- Move language selection to a dedicated page? https://github.com/python/docs-community/issues/14
- Having a "fast path" for documentation contributions [python/docs-community#13](https://github.com/python/docs-community/issues/13)
- Move language selection to a dedicated page? [python/docs-community#14](https://github.com/python/docs-community/issues/14)
> This seems like a good idea. :P [the-guy-who-filed-the-issue AKA Pradyun]
- Docs WG monthly meeting #1 https://github.com/python/docs-community/issues/15
- Docs WG monthly meeting #1 [python/docs-community#15](https://github.com/python/docs-community/issues/15)
> This one is a bit self-recursive, eh? :) [CAM-Gerlach]
</details>
Expand All @@ -206,18 +206,18 @@ From the issue tracker:
The group's docs are incomplete. Should we fill in the blanks? Scrap some pages and focus on docs?

- Adding and onboarding new workgroup members
https://docs-community.readthedocs.io/en/latest/workgroup/adding-members.html
[docs-community.readthedocs.io/en/latest/workgroup/adding-members.html](https://docs-community.readthedocs.io/en/latest/workgroup/adding-members.html)

- Milestones and roadmaps
https://docs-community.readthedocs.io/en/latest/workgroup/milestones.html
[docs-community.readthedocs.io/en/latest/workgroup/milestones.html](https://docs-community.readthedocs.io/en/latest/workgroup/milestones.html)

- Discussion platform
https://docs-community.readthedocs.io/en/latest/community/contributing.html
[docs-community.readthedocs.io/en/latest/community/contributing.html](https://docs-community.readthedocs.io/en/latest/community/contributing.html)

Discourse, Discord, GH issues, any more?

- Documentation Team
https://docs-community.readthedocs.io/en/latest/community/team.html
[docs-community.readthedocs.io/en/latest/community/team.html](https://docs-community.readthedocs.io/en/latest/community/team.html)

Who should be in the Community team?

Expand All @@ -232,8 +232,8 @@ The style guide could cover questions like:
- How to best use code examples
- When to use "roughly equivalent" implementations
- How to divide different kinds of documentation
- https://documentation.divio.com/
- https://diataxis.fr/
- [documentation.divio.com](https://documentation.divio.com/)
- [diataxis.fr](https://diataxis.fr/)

Book suggestion: [Docs for Developers](https://docsfordevelopers.com/)

Expand Down
8 changes: 4 additions & 4 deletions docs/monthly-meeting/2022-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Please take a second to read through it!

## Quick updates - Introductions

- Julien https://github.com/sphinx-contrib/sphinx-lint
- Julien [sphinx-contrib/sphinx-lint](https://github.com/sphinx-contrib/sphinx-lint)
- fork of the rstlint.py from CPython, as an independent project

## Reports and celebrations
Expand Down Expand Up @@ -70,7 +70,7 @@ Please take a second to read through it!
* Helping the typing community move their PEPs into a separate spot.
* In the Python documentation? Outside of Python documentation?
* There's an ongoing effort?
* https://typing.readthedocs.io/en/latest/
* [typing.readthedocs.io](https://typing.readthedocs.io/en/latest/)
* Should the typing specifications live in Python docs or externally?
* The fact that core developers don't care strongly about typing documentation isn't a good reason to keep them external to it.
* PEPs are not documentation.
Expand Down Expand Up @@ -107,8 +107,8 @@ The style guide could cover questions like:
- How to best use code examples
- When to use "roughly equivalent" implementations
- How to divide different kinds of documentation
- https://documentation.divio.com/
- https://diataxis.fr/
- [documentation.divio.com](https://documentation.divio.com/)
- [diataxis.fr](https://diataxis.fr/)
- First step could be understanding how the current docs align with the diataxis framework

Book suggestion: [Docs for Developers](https://docsfordevelopers.com/)
Expand Down
20 changes: 10 additions & 10 deletions docs/monthly-meeting/2022-04.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,11 +40,11 @@ Office hours @BostonPython - [choose your own adventure](https://github.com/nedb

GitHub Issues migration plan

https://github.com/python/peps/issues/2497
[python/peps#2497](https://github.com/python/peps/issues/2497)

We will update PEP 588 with current plan of migration. Don't create yet another PEP.

Devguide PR: https://github.com/python/devguide/pull/814
Devguide PR: [python/devguide#814](https://github.com/python/devguide/pull/814)

- [x] **Mariatta**: reply

Expand All @@ -62,7 +62,7 @@ Devguide PR: https://github.com/python/devguide/pull/814

- If there's any updates/issues that would be relevant to the Python core developers, this would be a good place for presenting that for discussion!
- Still in planning stage, but worth it to start thinking about it now, if you want to bring up something for discussion.
- Signup: https://us.pycon.org/2022/events/language-summit/
- Signup: [us.pycon.org/2022/events/language-summit/](https://us.pycon.org/2022/events/language-summit/)
- We talked about the docs group at the last 2 lang summits. This time the group has started!
- Desires for revamping the main CPython documentation theme might be a topic for discussion?
- Lightning talk sounds good
Expand All @@ -77,7 +77,7 @@ Devguide PR: https://github.com/python/devguide/pull/814
* Helping the typing community move their PEPs into a separate spot.
* In the Python documentation? Outside of Python documentation?
* There's an ongoing effort?
* https://typing.readthedocs.io/en/latest/
* [typing.readthedocs.io](https://typing.readthedocs.io/en/latest/)
* Should the typing specifications live in Python docs or externally?
* The fact that core developers don't care strongly about typing documentation isn't a good reason to keep them external to it.
* PEPs are not documentation.
Expand Down Expand Up @@ -130,18 +130,18 @@ Discussion outside the meeting should be on the issues :)
The group's docs are incomplete. Should we fill in the blanks? Scrap some pages and focus on docs?

- Adding and onboarding new workgroup members
https://docs-community.readthedocs.io/en/latest/workgroup/adding-members.html
[docs-community.readthedocs.io/en/latest/workgroup/adding-members.html](https://docs-community.readthedocs.io/en/latest/workgroup/adding-members.html)

- Milestones and roadmaps
https://docs-community.readthedocs.io/en/latest/workgroup/milestones.html
[docs-community.readthedocs.io/en/latest/workgroup/milestones.html](https://docs-community.readthedocs.io/en/latest/workgroup/milestones.html)

- Discussion platform
https://docs-community.readthedocs.io/en/latest/community/contributing.html
[docs-community.readthedocs.io/en/latest/community/contributing.html](https://docs-community.readthedocs.io/en/latest/community/contributing.html)

Discourse, Discord, GH issues, any more?

- Documentation Team
https://docs-community.readthedocs.io/en/latest/community/team.html
[docs-community.readthedocs.io/en/latest/community/team.html](https://docs-community.readthedocs.io/en/latest/community/team.html)

Who should be in the Community team?

Expand All @@ -155,8 +155,8 @@ The style guide could cover questions like:
- How to best use code examples
- When to use "roughly equivalent" implementations
- How to divide different kinds of documentation
- https://documentation.divio.com/
- https://diataxis.fr/
- [documentation.divio.com](https://documentation.divio.com/)
- [diataxis.fr](https://diataxis.fr/)
- First step could be understanding how the current docs align with the diataxis framework

Book suggestion: [Docs for Developers](https://docsfordevelopers.com/)
Expand Down
6 changes: 3 additions & 3 deletions docs/monthly-meeting/2022-06.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Update: CAM didn't see any reviews or feedback on his PRs. (He did take some tim
- [ ] Creating a 'docs-approved' (wording to be agreed) label for CPython.

Needs discussion, please open issue on core-workflow repo.
(There's a template for label changes: https://github.com/python/core-workflow/issues/new/choose)
(There's a template for label changes: [python/core-workflow/issues/new/choose](https://github.com/python/core-workflow/issues/new/choose))


### 'Internal' items
Expand Down Expand Up @@ -123,15 +123,15 @@ Ned: Is a problem that we have different audiences? E.g. triagers versus develop
Guido: The three audiences should be (core devs & triagers), contributors, and redistributors/people who need to build Python.

> 2. add a "tips and tricks" page
> There is some overlapping between https://devguide.python.org/communication/, the instructions that I want to add, the tips and tricks page, and other pages like the GitHub bootcamp though, so I'm still trying to figure out all the things I want to include and then what would be the best way to organize them.
> There is some overlapping between [devguide.python.org/communication/](https://devguide.python.org/communication/), the instructions that I want to add, the tips and tricks page, and other pages like the GitHub bootcamp though, so I'm still trying to figure out all the things I want to include and then what would be the best way to organize them.
Ned: This sounds like Ezio is suggestion that the devguide should have a 'how to' section (one of the four sections of Diataxis).

- [ ] Ezio: Add a (How-To) Guides section with these

#### Adopting Diátaxis

https://discuss.python.org/t/adopting-the-diataxis-framework-for-python-documentation/15072
[discuss.python.org/t/adopting-the-diataxis-framework-for-python-documentation/15072](https://discuss.python.org/t/adopting-the-diataxis-framework-for-python-documentation/15072)

What's the next step -- survey what we already have, as [Ezio suggested](https://discuss.python.org/t/adopting-the-diataxis-framework-for-python-documentation/15072/37)?

Expand Down
24 changes: 12 additions & 12 deletions docs/monthly-meeting/2022-07.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
- **Date:** 2022-07-11
- **Time:** [21:00 UTC]<!--(https://arewemeetingyet.com/UTC/2022-07-11/21:00/Docs%20Meeting)-->
- **This HackMD:** [https://hackmd.io/@encukou/pydocswg1](https://hackmd.io/@encukou/pydocswg1)
- **Discourse thread:** https://discuss.python.org/t/16317
- **Discourse thread:** [discuss.python.org/t/16317](https://discuss.python.org/t/16317)
- **Calendar for future meetings:** (send your e-mail to Mariatta for a calendar invitation)
- **How to participate:**
- Join the Python Docs discord: https://discord.gg/sMWqvzXvde
- Join the Python Docs discord: [discord.gg/sMWqvzXvde](https://discord.gg/sMWqvzXvde)
- Use the "General Voice" channel (it does video)
- To bring up the side chat: click in the "speech balloon" in General Voice (on Web/desktop, hover over "General Voice" in the side bar to see it)

Expand Down Expand Up @@ -40,7 +40,7 @@ Please take a second to read through it!
* Hugo

- Documenting deprecations in What's New
https://docs.python.org/3.12/whatsnew/3.12.html#deprecated
[docs.python.org/3.12/whatsnew/3.12.html#deprecated](https://docs.python.org/3.12/whatsnew/3.12.html#deprecated)


## Reports and celebrations
Expand All @@ -60,23 +60,23 @@ Please take a second to read through it!
- Update: CAM didn't see any reviews or feedback on his PRs. (He did take some time off from Python work.)
- CAM: Petr ended up more or less doing this first, so I think we can check this off
- [x] Adam: Creating a 'docs-approved' (wording to be agreed) label for CPython.
- https://github.com/python/core-workflow/issues/458
- [python/core-workflow#458](https://github.com/python/core-workflow/issues/458)
- Created as the `@python/proofreaders` team
- [x] Petr: Start the Docs WG → Editorial Board rename
- https://github.com/python/docs-community/pull/55
- [python/docs-community#55](https://github.com/python/docs-community/pull/55)
- [x] Petr: Solicit agenda items on Discourse for the next/future meetings
- https://discuss.python.org/t/16317
- [discuss.python.org/t/16317](https://discuss.python.org/t/16317)
- [x] Petr: Create a `proofreaders` team (Initially: CAM, Adam, Pradyun, Hugo), post about this team on Discourse for a wider audience
- https://discuss.python.org/t/16319
- [discuss.python.org/t/16319](https://discuss.python.org/t/16319)
- [ ] Ezio: Add a “what's new” section to the devguide (key/important changes)
- https://github.com/python/devguide/issues/885
- [python/devguide#885](https://github.com/python/devguide/issues/885)
- Should we use blurb?
- start simple, then move to blurb if needed
- Waiting for the devguide reorg
- [ ] Ezio: Add a (How-To) Guides section to devguide
- Waiting for the reorg and still thinking about the best way to approach this :thinking_face:
- [x] Mariatta: to work with Daniele to organize Diátaxis workshop, CAM & Ned to help with logistics.
- https://discuss.python.org/t/announcing-the-diataxis-documentation-workshop/17075
- [discuss.python.org/t/announcing-the-diataxis-documentation-workshop/17075](https://discuss.python.org/t/announcing-the-diataxis-documentation-workshop/17075)


### 'Internal' items
Expand Down Expand Up @@ -115,7 +115,7 @@ None
* [ ] Try building automation using the .inv file

* Reorganize the devguide in directories
* https://github.com/python/devguide/pull/901
* [python/devguide#901](https://github.com/python/devguide/pull/901)
* Squash merge or rebase?
* rebase

Expand All @@ -125,10 +125,10 @@ None

* Should we apply the `skip news` label to documentation PRs?
* [Discussion in Bedevere's tracker](https://github.com/python/bedevere/issues/457).
* PR: https://github.com/python/bedevere/pull/485
* PR: [python/bedevere#485](https://github.com/python/bedevere/pull/485)
* Labels semantics on PRs vs issues (`stdlib`/`tests`/`docs`/etc.)
* not blocked
* Need an admin to create Netlify account: https://github.com/python/cpython/pull/92852
* Need an admin to create Netlify account: [python/cpython#92852](https://github.com/python/cpython/pull/92852)


## Any Other Business
Expand Down
Loading

0 comments on commit 90923f6

Please sign in to comment.