Issue #20255: Update the about and bugs pages.
This commit is contained in:
parent
9774ce0cab
commit
71337cb281
|
@ -7,14 +7,15 @@ These documents are generated from `reStructuredText`_ sources by `Sphinx`_, a
|
|||
document processor specifically written for the Python documentation.
|
||||
|
||||
.. _reStructuredText: http://docutils.sf.net/rst.html
|
||||
.. _Sphinx: http://sphinx.pocoo.org/
|
||||
.. _Sphinx: http://sphinx-doc.org/
|
||||
|
||||
.. In the online version of these documents, you can submit comments and suggest
|
||||
changes directly on the documentation pages.
|
||||
|
||||
Development of the documentation and its toolchain takes place on the
|
||||
docs@python.org mailing list. We're always looking for volunteers wanting
|
||||
to help with the docs, so feel free to send a mail there!
|
||||
Development of the documentation and its toolchain is an entirely volunteer
|
||||
effort, just like Python itself. If you want to contribute, please take a
|
||||
look at the :ref:`reporting-bugs` page for information on how to do so. New
|
||||
volunteers are always welcome!
|
||||
|
||||
Many thanks go to:
|
||||
|
||||
|
@ -26,9 +27,6 @@ Many thanks go to:
|
|||
<http://effbot.org/zone/pyref.htm>`_ project from which Sphinx got many good
|
||||
ideas.
|
||||
|
||||
See :ref:`reporting-bugs` for information how to report bugs in this
|
||||
documentation, or Python itself.
|
||||
|
||||
|
||||
Contributors to the Python Documentation
|
||||
----------------------------------------
|
||||
|
|
30
Doc/bugs.rst
30
Doc/bugs.rst
|
@ -13,15 +13,17 @@ Documentation bugs
|
|||
==================
|
||||
|
||||
If you find a bug in this documentation or would like to propose an improvement,
|
||||
please send an e-mail to docs@python.org describing the bug and where you found
|
||||
it. If you have a suggestion how to fix it, include that as well.
|
||||
please submit a bug report on the :ref:`tracker <using-the-tracker>`. If you
|
||||
have a suggestion how to fix it, include that as well.
|
||||
|
||||
docs@python.org is a mailing list run by volunteers; your request will be
|
||||
noticed, even if it takes a while to be processed.
|
||||
If you're short on time, you can also email your bug report to docs@python.org.
|
||||
'docs@' is a mailing list run by volunteers; your request will be noticed,
|
||||
though it may take a while to be processed.
|
||||
|
||||
Of course, if you want a more persistent record of your issue, you can use the
|
||||
issue tracker for documentation bugs as well.
|
||||
.. seealso::
|
||||
`Documentation bugs`_ on the Python issue tracker
|
||||
|
||||
.. _using-the-tracker:
|
||||
|
||||
Using the Python issue tracker
|
||||
==============================
|
||||
|
@ -62,9 +64,6 @@ taken on the bug.
|
|||
|
||||
.. seealso::
|
||||
|
||||
`Python Developer's Guide <http://docs.python.org/devguide/>`_
|
||||
Detailed description of the issue workflow and developers tools.
|
||||
|
||||
`How to Report Bugs Effectively <http://www.chiark.greenend.org.uk/~sgtatham/bugs.html>`_
|
||||
Article which goes into some detail about how to create a useful bug report.
|
||||
This describes what kind of information is useful and why it is useful.
|
||||
|
@ -73,3 +72,16 @@ taken on the bug.
|
|||
Information about writing a good bug report. Some of this is specific to the
|
||||
Mozilla project, but describes general good practices.
|
||||
|
||||
|
||||
Getting started contributing to Python yourself
|
||||
===============================================
|
||||
|
||||
Beyond just reporting bugs that you find, you are also welcome to submit
|
||||
patches to fix them. You can find more information on how to get started
|
||||
patching Python in the `Python Developer's Guide`_. If you have questions,
|
||||
the `core-mentorship mailing list`_ is a friendly place to get answers to
|
||||
any and all questions pertaining to the process of fixing issues in Python.
|
||||
|
||||
.. _Documentation bugs: http://bugs.python.org/issue?@filter=status&@filter=components&components=4&status=1&@columns=id,activity,title,status&@sort=-activity
|
||||
.. _Python Developer's Guide: http://docs.python.org/devguide/
|
||||
.. _core-mentorship mailing list: https://mail.python.org/mailman/listinfo/core-mentorship/
|
||||
|
|
Loading…
Reference in New Issue