You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/monthly-meeting/2022-02.md
+24-24Lines changed: 24 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ On the first meeting, let's use this slot for an introduction!
22
22
## Roll call:
23
23
24
24
-[name] / affiliation / github username
25
-
-[Pradyun] / :shrug: / @pradyunsg
25
+
-[Pradyun] / 🤷 / @pradyunsg
26
26
-[willingc] / Core Dev / willingc
27
27
-[Ned] / edX, Open edX, Boston Python, Coverage.py / @nedbat
28
28
- James
@@ -35,15 +35,15 @@ On the first meeting, let's use this slot for an introduction!
35
35
36
36
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.
37
37
38
-
- Welcome Documentarians :smile:
38
+
- Welcome Documentarians 😀
39
39
40
40
> TIL about HackMD's `[name=Pradyun]` syntax, and it's great! [Pradyun]
41
41
>
42
42
>> editor's note: it doesn't work outside HackMD, and has been replaced by [name] in this document
43
43
44
-
> 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]
44
+
> 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]
45
45
46
-
> Thanks @encukou for kicking this off. :tada:[willingc]
46
+
> Thanks @encukou for kicking this off. 🎉[willingc]
47
47
48
48
## Agenda items
49
49
@@ -74,7 +74,7 @@ A "guidance document is at the end of the document"
74
74
75
75
[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.
76
76
77
-
[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.
77
+
[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.
78
78
Guidance, like dividing docs into 4 quadrants, would help.
79
79
80
80
[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.
@@ -127,7 +127,7 @@ Even if Docs WG is the place where people submit ideas and others implement them
127
127
128
128
[Ned] Sounds like a good issue to file.
129
129
130
-
[Petr] Filing an issue. (https://github.com/python/docs-community/issues/17)
130
+
[Petr] Filing an issue. ([python/docs-community#17](https://github.com/python/docs-community/issues/17))
131
131
132
132
[Paul] You can probably blame the CLA process on me.
133
133
@@ -176,24 +176,24 @@ GitHub team under the `python` org? Would have issues with adding people to the
176
176
177
177
From the issue tracker:
178
178
179
-
- Migration of theme to modern responsive theme https://github.com/python/docs-community/issues/1
179
+
- Migration of theme to modern responsive theme [python/docs-community#1](https://github.com/python/docs-community/issues/1)
180
180
> 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]
181
-
- Post the application process for workgroup members https://github.com/python/docs-community/issues/3
182
-
- Enhancing the switchers setup https://github.com/python/docs-community/issues/4
181
+
- Post the application process for workgroup members [python/docs-community#3](https://github.com/python/docs-community/issues/3)
182
+
- Enhancing the switchers setup [python/docs-community#4](https://github.com/python/docs-community/issues/4)
- Suggestions from Python Language Summit [python/docs-community#6](https://github.com/python/docs-community/issues/6)
186
+
- Mobile friendly theme for wiki.python.org [python/docs-community#7](https://github.com/python/docs-community/issues/7)
187
187
> 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]
188
-
- Suggestions and ideas from Typing Summit https://github.com/python/docs-community/issues/8
189
-
- French translation sprint https://github.com/python/docs-community/issues/9
190
-
- Use Sphinx for pep builds and better rendering https://github.com/python/docs-community/issues/10
188
+
- Suggestions and ideas from Typing Summit [python/docs-community#8](https://github.com/python/docs-community/issues/8)
189
+
- French translation sprint [python/docs-community#9](https://github.com/python/docs-community/issues/9)
190
+
- Use Sphinx for pep builds and better rendering [python/docs-community#10](https://github.com/python/docs-community/issues/10)
191
191
> 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]
192
192
- Is it in scope? :)
193
-
- Having a "fast path" for documentation contributions https://github.com/python/docs-community/issues/13
194
-
- Move language selection to a dedicated page? https://github.com/python/docs-community/issues/14
193
+
- Having a "fast path" for documentation contributions [python/docs-community#13](https://github.com/python/docs-community/issues/13)
194
+
- Move language selection to a dedicated page? [python/docs-community#14](https://github.com/python/docs-community/issues/14)
195
195
> This seems like a good idea. :P[the-guy-who-filed-the-issue AKA Pradyun]
196
-
- Docs WG monthly meeting #1https://github.com/python/docs-community/issues/15
196
+
- Docs WG monthly meeting #1[python/docs-community#15](https://github.com/python/docs-community/issues/15)
197
197
> This one is a bit self-recursive, eh? :) [CAM-Gerlach]
198
198
199
199
</details>
@@ -206,18 +206,18 @@ From the issue tracker:
206
206
The group's docs are incomplete. Should we fill in the blanks? Scrap some pages and focus on docs?
Copy file name to clipboardExpand all lines: docs/monthly-meeting/2022-06.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ Update: CAM didn't see any reviews or feedback on his PRs. (He did take some tim
49
49
-[ ] Creating a 'docs-approved' (wording to be agreed) label for CPython.
50
50
51
51
Needs discussion, please open issue on core-workflow repo.
52
-
(There's a template for label changes: https://github.com/python/core-workflow/issues/new/choose)
52
+
(There's a template for label changes: [python/core-workflow/issues/new/choose](https://github.com/python/core-workflow/issues/new/choose))
53
53
54
54
55
55
### 'Internal' items
@@ -123,15 +123,15 @@ Ned: Is a problem that we have different audiences? E.g. triagers versus develop
123
123
Guido: The three audiences should be (core devs & triagers), contributors, and redistributors/people who need to build Python.
124
124
125
125
> 2. add a "tips and tricks" page
126
-
> 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.
126
+
> 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.
127
127
128
128
Ned: This sounds like Ezio is suggestion that the devguide should have a 'how to' section (one of the four sections of Diataxis).
129
129
130
130
-[ ] Ezio: Add a (How-To) Guides section with these
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)?
0 commit comments