From 8e4343b206be1660388c59e8851378e7153063e4 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 17:20:32 +0100 Subject: [PATCH 01/14] Expand the Python sprint to cover documentation --- src/content/sprints/cpython.md | 31 +++++++++++++++++++++++++++---- 1 file changed, 27 insertions(+), 4 deletions(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index 7f8547322..3d00406f9 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -1,20 +1,30 @@ --- -title: "CPython Core" +title: "CPython Core & Python Documentation" numberOfPeople: "TBA" -pythonLevel: "Intermediate" +pythonLevel: "Intermediate [Core] or Any [Documentation]" contactPerson: name: "Petr Viktorin" email: links: - title: "CPython's Developer Guide" - url: "https://devguide.python.org/" + url: "https://devguide.python.org/" + - title: "Setup & Building [CPython core]" + url: "https://devguide.python.org/getting-started/setup-building/" + - title: "Start Documenting [Python documentation]" + url: "https://devguide.python.org/documentation/start-documenting/" + - title: "Helping with Documentation [Python documentation]" + url: "https://devguide.python.org/documentation/help-documenting/" - title: "Code of Conduct" url: "https://policies.python.org/python.org/code-of-conduct/" - title: "Easy Issues" url: "https://github.com/python/cpython/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy" --- -Come sprint on CPython and work on Python 3.14 and 3.15! +Come sprint on CPython and work on Python 3.14 and 3.15, or Python's documentation! + +### CPython Core + +Contacts: **Petr Viktorin** Sprints will focus on release candidate fixes to Python 3.14 (to be released this October), with some limited new feature work for 3.15 (final version in @@ -28,3 +38,16 @@ October 2026). wifi :) 4. Use the [Python Developer's Guide](https://devguide.python.org/) to go through the initial build on you machine. + +### Python Documentation + +Contacts: **Adam Turner** + +Help us with Python's documentation! + +We'll be working on all parts of the documentation, so all any any changes are welcome -- from fixing a spelling error to improving an entire page. + +1. Read ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) for a briefing on what happens at sprints in general. + This was written for the PyCon US sprints, but a lot applies here!. +1. Fork and clone the [repository](https://github.com/python/cpython/fork) **before** arriving at the sprints, to get started faster. +1. Use the [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) to set up an environment for contributing to the documentation. From 43805b8f81d353b945b26f77d4d96c53d57d5bae Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 16 Jul 2025 16:27:54 +0000 Subject: [PATCH 02/14] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/content/sprints/cpython.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index 3d00406f9..d079d5855 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -7,7 +7,7 @@ contactPerson: email: links: - title: "CPython's Developer Guide" - url: "https://devguide.python.org/" + url: "https://devguide.python.org/" - title: "Setup & Building [CPython core]" url: "https://devguide.python.org/getting-started/setup-building/" - title: "Start Documenting [Python documentation]" @@ -20,7 +20,8 @@ links: url: "https://github.com/python/cpython/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy" --- -Come sprint on CPython and work on Python 3.14 and 3.15, or Python's documentation! +Come sprint on CPython and work on Python 3.14 and 3.15, or Python's +documentation! ### CPython Core @@ -45,9 +46,15 @@ Contacts: **Adam Turner** Help us with Python's documentation! -We'll be working on all parts of the documentation, so all any any changes are welcome -- from fixing a spelling error to improving an entire page. - -1. Read ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) for a briefing on what happens at sprints in general. - This was written for the PyCon US sprints, but a lot applies here!. -1. Fork and clone the [repository](https://github.com/python/cpython/fork) **before** arriving at the sprints, to get started faster. -1. Use the [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) to set up an environment for contributing to the documentation. +We'll be working on all parts of the documentation, so all any any changes are +welcome -- from fixing a spelling error to improving an entire page. + +1. Read + ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) + for a briefing on what happens at sprints in general. This was written for + the PyCon US sprints, but a lot applies here!. +1. Fork and clone the [repository](https://github.com/python/cpython/fork) + **before** arriving at the sprints, to get started faster. +1. Use the + [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) + to set up an environment for contributing to the documentation. From ac76eafd0f1877f5eebf5e1ed5c4d6be60cba76c Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 21:08:11 +0100 Subject: [PATCH 03/14] Update cpython.md --- src/content/sprints/cpython.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index d079d5855..a7cf9e571 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -1,7 +1,7 @@ --- title: "CPython Core & Python Documentation" numberOfPeople: "TBA" -pythonLevel: "Intermediate [Core] or Any [Documentation]" +pythonLevel: "Any" contactPerson: name: "Petr Viktorin" email: From 3ec326252a22be457c9fa0011b29448de390003b Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 21:08:17 +0100 Subject: [PATCH 04/14] Update cpython.md --- src/content/sprints/cpython.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index a7cf9e571..c4b7ae63e 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -25,7 +25,8 @@ documentation! ### CPython Core -Contacts: **Petr Viktorin** +Contacts: **Petr Viktorin, Adam Turner** \ +Experience Level: **Intermediate or Advanced** Sprints will focus on release candidate fixes to Python 3.14 (to be released this October), with some limited new feature work for 3.15 (final version in From 11dd32d227e691cf6eccbc9bf361a80830ebd02b Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 21:08:22 +0100 Subject: [PATCH 05/14] Update cpython.md --- src/content/sprints/cpython.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index c4b7ae63e..6a588759b 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -43,7 +43,8 @@ October 2026). ### Python Documentation -Contacts: **Adam Turner** +Contacts: **Adam Turner** \ +Experience Level: **Any** Help us with Python's documentation! From 4ae90268b0a3f4db9a04fc2647c971114eab8320 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 16 Jul 2025 20:09:00 +0000 Subject: [PATCH 06/14] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/content/sprints/cpython.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index 6a588759b..a5b23be45 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -25,7 +25,7 @@ documentation! ### CPython Core -Contacts: **Petr Viktorin, Adam Turner** \ +Contacts: **Petr Viktorin, Adam Turner** \ Experience Level: **Intermediate or Advanced** Sprints will focus on release candidate fixes to Python 3.14 (to be released @@ -43,7 +43,7 @@ October 2026). ### Python Documentation -Contacts: **Adam Turner** \ +Contacts: **Adam Turner** \ Experience Level: **Any** Help us with Python's documentation! From 01aecff1c573b43cd746ebfc6877a878ff6e0330 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 21:41:29 +0100 Subject: [PATCH 07/14] H5 --- src/content/sprints/cpython.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index a5b23be45..f5d87a460 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -23,7 +23,7 @@ links: Come sprint on CPython and work on Python 3.14 and 3.15, or Python's documentation! -### CPython Core +##### CPython Core Contacts: **Petr Viktorin, Adam Turner** \ Experience Level: **Intermediate or Advanced** From bd80063e63b276188fac37821e0e53433989df3e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Wed, 16 Jul 2025 21:41:38 +0100 Subject: [PATCH 08/14] H5 --- src/content/sprints/cpython.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index f5d87a460..a5f870e7a 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -41,7 +41,7 @@ October 2026). 4. Use the [Python Developer's Guide](https://devguide.python.org/) to go through the initial build on you machine. -### Python Documentation +##### Python Documentation Contacts: **Adam Turner** \ Experience Level: **Any** From 6fb2e393e7970cdb644507144aac89a28965afb4 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 17 Jul 2025 06:51:22 +0100 Subject: [PATCH 09/14] Split the pages --- src/content/sprints/cpython-documentation.md | 32 +++++++++++++++++ src/content/sprints/cpython.md | 38 +++----------------- 2 files changed, 36 insertions(+), 34 deletions(-) create mode 100644 src/content/sprints/cpython-documentation.md diff --git a/src/content/sprints/cpython-documentation.md b/src/content/sprints/cpython-documentation.md new file mode 100644 index 000000000..82175d416 --- /dev/null +++ b/src/content/sprints/cpython-documentation.md @@ -0,0 +1,32 @@ +--- +title: "Python Documentation" +numberOfPeople: "TBA" +pythonLevel: "Any" +contactPerson: + name: "Adam Turner" + github: AA-Turner +links: + - title: "Start Documenting" + url: "https://devguide.python.org/documentation/start-documenting/" + - title: "Helping with Documentation" + url: "https://devguide.python.org/documentation/help-documenting/" + - title: "Easy Issues" + url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" + - title: "Code of Conduct" + url: "https://policies.python.org/python.org/code-of-conduct/" +--- + +Help us improve the Python documentation! + +We'll be working on all parts of the documentation, so all any any changes are +welcome -- from fixing a spelling error to documenting a new feature. + +1. Read + ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) + for a briefing on what happens at sprints in general. This was written for + the PyCon US sprints, but a lot applies here!. +1. Fork and clone the [repository](https://github.com/python/cpython/fork) + **before** arriving at the sprints, to get started faster. +1. Use the + [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) + to set up an environment for contributing to the documentation. diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index a5f870e7a..faac13dfa 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -1,32 +1,22 @@ --- -title: "CPython Core & Python Documentation" +title: "CPython Core numberOfPeople: "TBA" -pythonLevel: "Any" +pythonLevel: "Intermediate contactPerson: name: "Petr Viktorin" email: links: - title: "CPython's Developer Guide" url: "https://devguide.python.org/" - - title: "Setup & Building [CPython core]" + - title: "Setup & Building" url: "https://devguide.python.org/getting-started/setup-building/" - - title: "Start Documenting [Python documentation]" - url: "https://devguide.python.org/documentation/start-documenting/" - - title: "Helping with Documentation [Python documentation]" - url: "https://devguide.python.org/documentation/help-documenting/" - title: "Code of Conduct" url: "https://policies.python.org/python.org/code-of-conduct/" - title: "Easy Issues" url: "https://github.com/python/cpython/issues?q=is%3Aissue+is%3Aopen+label%3Aeasy" --- -Come sprint on CPython and work on Python 3.14 and 3.15, or Python's -documentation! - -##### CPython Core - -Contacts: **Petr Viktorin, Adam Turner** \ -Experience Level: **Intermediate or Advanced** +Come sprint on CPython and work on Python 3.14 and 3.15! Sprints will focus on release candidate fixes to Python 3.14 (to be released this October), with some limited new feature work for 3.15 (final version in @@ -40,23 +30,3 @@ October 2026). wifi :) 4. Use the [Python Developer's Guide](https://devguide.python.org/) to go through the initial build on you machine. - -##### Python Documentation - -Contacts: **Adam Turner** \ -Experience Level: **Any** - -Help us with Python's documentation! - -We'll be working on all parts of the documentation, so all any any changes are -welcome -- from fixing a spelling error to improving an entire page. - -1. Read - ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) - for a briefing on what happens at sprints in general. This was written for - the PyCon US sprints, but a lot applies here!. -1. Fork and clone the [repository](https://github.com/python/cpython/fork) - **before** arriving at the sprints, to get started faster. -1. Use the - [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) - to set up an environment for contributing to the documentation. From 6d3f1928a2a4c022cecbdc1b9e444e08de299460 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 17 Jul 2025 06:52:23 +0100 Subject: [PATCH 10/14] Add missing closing quotation marks --- src/content/sprints/cpython.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/content/sprints/cpython.md b/src/content/sprints/cpython.md index faac13dfa..67fc32a9f 100644 --- a/src/content/sprints/cpython.md +++ b/src/content/sprints/cpython.md @@ -1,7 +1,7 @@ --- -title: "CPython Core +title: "CPython Core" numberOfPeople: "TBA" -pythonLevel: "Intermediate +pythonLevel: "Intermediate" contactPerson: name: "Petr Viktorin" email: From 62098b313fdc8db638774c5e20018d7db13db4bd Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Thu, 17 Jul 2025 05:53:29 +0000 Subject: [PATCH 11/14] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/content/sprints/cpython-documentation.md | 64 ++++++++++---------- 1 file changed, 32 insertions(+), 32 deletions(-) diff --git a/src/content/sprints/cpython-documentation.md b/src/content/sprints/cpython-documentation.md index 82175d416..8ddb17037 100644 --- a/src/content/sprints/cpython-documentation.md +++ b/src/content/sprints/cpython-documentation.md @@ -1,32 +1,32 @@ ---- -title: "Python Documentation" -numberOfPeople: "TBA" -pythonLevel: "Any" -contactPerson: - name: "Adam Turner" - github: AA-Turner -links: - - title: "Start Documenting" - url: "https://devguide.python.org/documentation/start-documenting/" - - title: "Helping with Documentation" - url: "https://devguide.python.org/documentation/help-documenting/" - - title: "Easy Issues" - url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" - - title: "Code of Conduct" - url: "https://policies.python.org/python.org/code-of-conduct/" ---- - -Help us improve the Python documentation! - -We'll be working on all parts of the documentation, so all any any changes are -welcome -- from fixing a spelling error to documenting a new feature. - -1. Read - ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) - for a briefing on what happens at sprints in general. This was written for - the PyCon US sprints, but a lot applies here!. -1. Fork and clone the [repository](https://github.com/python/cpython/fork) - **before** arriving at the sprints, to get started faster. -1. Use the - [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) - to set up an environment for contributing to the documentation. +--- +title: "Python Documentation" +numberOfPeople: "TBA" +pythonLevel: "Any" +contactPerson: + name: "Adam Turner" + github: AA-Turner +links: + - title: "Start Documenting" + url: "https://devguide.python.org/documentation/start-documenting/" + - title: "Helping with Documentation" + url: "https://devguide.python.org/documentation/help-documenting/" + - title: "Easy Issues" + url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" + - title: "Code of Conduct" + url: "https://policies.python.org/python.org/code-of-conduct/" +--- + +Help us improve the Python documentation! + +We'll be working on all parts of the documentation, so all any any changes are +welcome -- from fixing a spelling error to documenting a new feature. + +1. Read + ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) + for a briefing on what happens at sprints in general. This was written for + the PyCon US sprints, but a lot applies here!. +1. Fork and clone the [repository](https://github.com/python/cpython/fork) + **before** arriving at the sprints, to get started faster. +1. Use the + [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) + to set up an environment for contributing to the documentation. From 37ca69556022706534d5ef62a64917c454658f4b Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 17 Jul 2025 07:53:45 +0100 Subject: [PATCH 12/14] Update cpython-documentation.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- src/content/sprints/cpython-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython-documentation.md b/src/content/sprints/cpython-documentation.md index 8ddb17037..c0590be1f 100644 --- a/src/content/sprints/cpython-documentation.md +++ b/src/content/sprints/cpython-documentation.md @@ -28,5 +28,5 @@ welcome -- from fixing a spelling error to documenting a new feature. 1. Fork and clone the [repository](https://github.com/python/cpython/fork) **before** arriving at the sprints, to get started faster. 1. Use the - [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) + [Python Developer's Guide](https://devguide.python.org/documentation/start-documenting/) to set up an environment for contributing to the documentation. From ee54c0a2f57f3e8e9712d855844abfcae6ea888e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 17 Jul 2025 07:53:51 +0100 Subject: [PATCH 13/14] Update cpython-documentation.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- src/content/sprints/cpython-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython-documentation.md b/src/content/sprints/cpython-documentation.md index c0590be1f..0ee518708 100644 --- a/src/content/sprints/cpython-documentation.md +++ b/src/content/sprints/cpython-documentation.md @@ -24,7 +24,7 @@ welcome -- from fixing a spelling error to documenting a new feature. 1. Read ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) for a briefing on what happens at sprints in general. This was written for - the PyCon US sprints, but a lot applies here!. + the PyCon US sprints, but a lot applies here! 1. Fork and clone the [repository](https://github.com/python/cpython/fork) **before** arriving at the sprints, to get started faster. 1. Use the From 8091d0869aadbfb8ababede9feb7434049c0ecf9 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Thu, 17 Jul 2025 07:53:56 +0100 Subject: [PATCH 14/14] Update cpython-documentation.md Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- src/content/sprints/cpython-documentation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/content/sprints/cpython-documentation.md b/src/content/sprints/cpython-documentation.md index 0ee518708..f279f6735 100644 --- a/src/content/sprints/cpython-documentation.md +++ b/src/content/sprints/cpython-documentation.md @@ -18,7 +18,7 @@ links: Help us improve the Python documentation! -We'll be working on all parts of the documentation, so all any any changes are +We'll be working on all parts of the documentation, so all and any changes are welcome -- from fixing a spelling error to documenting a new feature. 1. Read