From 9a9221aa22feccc6320ec97e95a7d4f576f544ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20C=C3=A1rdenas?= Date: Wed, 11 Sep 2024 11:39:12 -0500 Subject: [PATCH 1/3] refac: #1315 clarify cpython documentation update process - update the documentation to specify that cpython docs are updated daily - removed the previous implication that updates occur only with cpython releases - clarified the connection between daily updates and the cpython release workflow --- documentation/devguide.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index a17ed342a9..70602456ce 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -19,10 +19,8 @@ main Python documentation, except for some small differences. The source lives in a `separate repository`_ and bug reports should be submitted to the `devguide GitHub tracker`_. -Our devguide workflow uses continuous integration and deployment so changes to -the devguide are normally published when the pull request is merged. Changes -to CPython documentation follow the workflow of a CPython release and are -published in the release. +Our devguide follows a continuous integration and deployment workflow, with changes published when pull requests are merged. +CPython documentation, on the other hand, is updated daily and aligns with the CPython release workflow, with changes being included in each release. Developer's Guide workflow From 34dc1ce25fd13e3e0d15d8f5dd47f919e3f2bacf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20C=C3=A1rdenas?= Date: Wed, 11 Sep 2024 14:37:37 -0500 Subject: [PATCH 2/3] refac: #1315 clarify cpython documentation update process - updated the explanation of cpython documentation updates - specified that updates occur regularly, tipically within a day or two - clarified that the documentation is versioned for each cpython release - improved the clarity of the relationship between releases and versions --- documentation/devguide.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index 70602456ce..a8ad157cf4 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -20,7 +20,9 @@ lives in a `separate repository`_ and bug reports should be submitted to the `devguide GitHub tracker`_. Our devguide follows a continuous integration and deployment workflow, with changes published when pull requests are merged. -CPython documentation, on the other hand, is updated daily and aligns with the CPython release workflow, with changes being included in each release. +CPython documentation is updated regularly, typically within a day or two, depending on the build process. +The documentation is versioned for each CPython release, and updates are continuosly incorporated, though with some delay due the build time. +Aditionally, each CPython release includes a corresponding version of the documentation, which may also be used by redistributors. Developer's Guide workflow From ed4821d8f1012bcaa7b9f902ae8411afb59ec06b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20C=C3=A1rdenas?= <78029302+miguelcsx@users.noreply.github.com> Date: Wed, 18 Sep 2024 22:18:44 -0500 Subject: [PATCH 3/3] Update documentation/devguide.rst - followed the maintainer's instructions to keep it consistent. Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> --- documentation/devguide.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/documentation/devguide.rst b/documentation/devguide.rst index a8ad157cf4..7c53d054e1 100644 --- a/documentation/devguide.rst +++ b/documentation/devguide.rst @@ -19,10 +19,12 @@ main Python documentation, except for some small differences. The source lives in a `separate repository`_ and bug reports should be submitted to the `devguide GitHub tracker`_. -Our devguide follows a continuous integration and deployment workflow, with changes published when pull requests are merged. -CPython documentation is updated regularly, typically within a day or two, depending on the build process. -The documentation is versioned for each CPython release, and updates are continuosly incorporated, though with some delay due the build time. -Aditionally, each CPython release includes a corresponding version of the documentation, which may also be used by redistributors. +Changes to the Developer's Guide are published when pull requests are merged. + +Changes to the Python documentation are published regularly, +ususally within 48 hours of the change being committed. +The documentation is also `published for each release `_, +which may also be used by redistributors. Developer's Guide workflow