[Python-checkins] bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (#12006)

Thu Mar 28 21:55:30 EDT 2019

https://github.com/python/cpython/commit/081158e3ba20dfa95d09cd652a44e271b95eb14c
commit: 081158e3ba20dfa95d09cd652a44e271b95eb14c
branch: master
author: Susan Su <susansu.software at gmail.com>
committer: Carol Willing <carolcode at willingconsulting.com>
date: 2019年03月28日T18:55:24-07:00
summary:
bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (#12006)
* 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 <susansu.software at gmail.com>
files:
A Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst
M Doc/bugs.rst
M Doc/tools/templates/indexcontent.html

diff --git a/Doc/bugs.rst b/Doc/bugs.rst
index c449ba2e7192..1e044ad2033d 100644
--- a/Doc/bugs.rst
+++ b/Doc/bugs.rst
@@ -25,7 +25,15 @@ docs at python.org (behavioral bugs can be sent to python-list at 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 <https://devguide.python.org/tracker/>`_
+ Overview of the process involved in reporting an improvement on the tracker.
+
+ `Helping with Documentation <https://devguide.python.org/docquality/#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 d795c0a5586b..152162ab0dd2 100644
--- a/Doc/tools/templates/indexcontent.html
+++ b/Doc/tools/templates/indexcontent.html
@@ -57,6 +57,7 @@ <h1>{{ docstitle|e }}</h1>
 <table class="contentstable" align="center"><tr>
 <td width="50%">
 <p class="biglink"><a class="biglink" href="{{ pathto("bugs") }}">{% trans %}Reporting bugs{% endtrans %}</a></p>
+ <p class="biglink"><a class="biglink" href="https://devguide.python.org/docquality/#helping-with-documentation">{% trans %}Contributing to Docs{% endtrans %}</a></p>
 <p class="biglink"><a class="biglink" href="{{ pathto("about") }}">{% trans %}About the documentation{% endtrans %}</a></p>
 </td><td width="50%">
 <p class="biglink"><a class="biglink" href="{{ pathto("license") }}">{% trans %}History and License of Python{% endtrans %}</a></p>
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 000000000000..124aa5e027ab
--- /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
