From 6eabaf561f4469faa338cfdd7c11e71e2df297f5 Mon Sep 17 00:00:00 2001 From: Susan Su Date: Thu, 21 Feb 2019 07:12:12 +0000 Subject: [PATCH 1/4] changes to html file -> added contributing to docs link at the end of the page --- Doc/tools/templates/indexcontent.html | 1 + 1 file changed, 1 insertion(+) diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index d795c0a5586bc8..152162ab0dd28c 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -57,6 +57,7 @@

{{ docstitle|e }}

{% trans %}Reporting bugs{% endtrans %}

+

{% trans %}Contributing to Docs{% endtrans %}

{% trans %}About the documentation{% endtrans %}

{% trans %}History and License of Python{% endtrans %}

From 51cdb67e7a359b5ec27ee4d72ff61b927296bc81 Mon Sep 17 00:00:00 2001 From: Susan Su Date: Sat, 23 Feb 2019 16:12:35 -0800 Subject: [PATCH 2/4] revisions to the dealing with bugs page. added more links in the documentation bugs section --- Doc/bugs.rst | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Doc/bugs.rst b/Doc/bugs.rst index c449ba2e719203..8e4722fd3064d4 100644 --- a/Doc/bugs.rst +++ b/Doc/bugs.rst @@ -25,7 +25,15 @@ docs@python.org (behavioral bugs can be sent to python-list@python.org). though it may take a while to be processed. .. seealso:: - `Documentation bugs`_ on the Python issue tracker + + `Documentation bugs`_ + Link to the Python issue tracker. Provides a list of documentation bugs that have been submitted. + + `Issue Tracking `_ + Overview of the process involved in reporting an improvement on the tracker. + + `Helping with Documentation `_ + Comprehensive guide for individuals that are interested in contributing to Python documentation. .. _using-the-tracker: From 4f1e26aa34f48e4698128e62c94105181bc07db1 Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" Date: Sun, 24 Feb 2019 03:15:11 +0000 Subject: [PATCH 3/4] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20blu?= =?UTF-8?q?rb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst diff --git a/Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst b/Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst new file mode 100644 index 00000000000000..124aa5e027abd2 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst @@ -0,0 +1 @@ +Updates the docs.python.org page with the addition of a 'Contributing to Docs' link at the end of the page (between 'Reporting Bugs' and 'About Documentation'). Updates the 'Found a Bug' page with additional links and information in the Documentation Bugs section. \ No newline at end of file From a0e6294c3c7546b7347dda4bdc304cb07bbfa1be Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sun, 10 Mar 2019 15:54:15 -0700 Subject: [PATCH 4/4] Update Doc/bugs.rst Updated Doc/bugs.rst in accordance with willingc and JulienPalard suggestions. Co-Authored-By: suhearsawho --- Doc/bugs.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/bugs.rst b/Doc/bugs.rst index 8e4722fd3064d4..1e044ad2033d87 100644 --- a/Doc/bugs.rst +++ b/Doc/bugs.rst @@ -27,7 +27,7 @@ though it may take a while to be processed. .. seealso:: `Documentation bugs`_ - Link to the Python issue tracker. Provides a list of documentation bugs that have been submitted. + A list of documentation bugs that have been submitted to the Python issue tracker. `Issue Tracking `_ Overview of the process involved in reporting an improvement on the tracker.