diff options
| author | Susan Su <susansu.software@gmail.com> | 2019-03-29 01:55:24 (GMT) |
|---|---|---|
| committer | Carol Willing <carolcode@willingconsulting.com> | 2019-03-29 01:55:24 (GMT) |
| commit | 081158e3ba20dfa95d09cd652a44e271b95eb14c (patch) | |
| tree | 2dfdaac5e20ae82246bac7e7c150f99f22ae623f | |
| parent | 74510e2a57f6d4b51ac1ab4f778cd7a4c54b541e (diff) | |
| download | cpython-081158e3ba20dfa95d09cd652a44e271b95eb14c.zip cpython-081158e3ba20dfa95d09cd652a44e271b95eb14c.tar.gz cpython-081158e3ba20dfa95d09cd652a44e271b95eb14c.tar.bz2 | |
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@gmail.com>
| -rw-r--r-- | Doc/bugs.rst | 10 | ||||
| -rw-r--r-- | Doc/tools/templates/indexcontent.html | 1 | ||||
| -rw-r--r-- | Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst | 1 |
3 files changed, 11 insertions, 1 deletions
diff --git a/Doc/bugs.rst b/Doc/bugs.rst index c449ba2..1e044ad 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 <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 d795c0a..152162a 100644 --- a/Doc/tools/templates/indexcontent.html +++ b/Doc/tools/templates/indexcontent.html @@ -57,6 +57,7 @@ <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 0000000..124aa5e --- /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 |