]> granicus.if.org Git - python/commitdiff
bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (#12006)
authorSusan Su <susansu.software@gmail.com>
Fri, 29 Mar 2019 01:55:24 +0000 (18:55 -0700)
committerCarol Willing <carolcode@willingconsulting.com>
Fri, 29 Mar 2019 01:55:24 +0000 (18:55 -0700)
* 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>
Doc/bugs.rst
Doc/tools/templates/indexcontent.html
Misc/NEWS.d/next/Documentation/2019-02-24-03-15-10.bpo-33043.8knWTS.rst [new file with mode: 0644]

index c449ba2e719203e77948f7f24535cb7bc7afb8db..1e044ad2033d87ebc9f6300627ec32c3fba334fa 100644 (file)
@@ -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:
 
index d795c0a5586bc8321f58679ffc2e618f5ba325e6..152162ab0dd28c7303d775e55e7844592ab0817c 100644 (file)
@@ -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 (file)
index 0000000..124aa5e
--- /dev/null
@@ -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