From 081158e3ba20dfa95d09cd652a44e271b95eb14c Mon Sep 17 00:00:00 2001 From: Susan Su Date: Thu, 28 Mar 2019 18:55:24 -0700 Subject: [PATCH] bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (#12006) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * changes to html file -> added contributing to docs link at the end of the page * revisions to the dealing with bugs page. added more links in the documentation bugs section * 📜🤖 Added by blurb_it. * Update Doc/bugs.rst Updated Doc/bugs.rst in accordance with willingc and JulienPalard suggestions. Co-Authored-By: suhearsawho --- Doc/bugs.rst | 10 +++++++++- Doc/tools/templates/indexcontent.html | 1 + .../2019-02-24-03-15-10.bpo-33043.8knWTS.rst | 1 + 3 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst diff --git a/Doc/bugs.rst b/Doc/bugs.rst index c449ba2e719..1e044ad2033 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`_ + 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. + + `Helping with Documentation `_ + Comprehensive guide for individuals that are interested in contributing to Python documentation. .. _using-the-tracker: diff --git a/Doc/tools/templates/indexcontent.html b/Doc/tools/templates/indexcontent.html index d795c0a5586..152162ab0dd 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -57,6 +57,7 @@
+ 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 00000000000..124aa5e027a --- /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