Skip to content

Helping with Documentation: Update old BPO info #1025

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 10, 2023
Merged

Helping with Documentation: Update old BPO info #1025

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2769aa5
Update info for GitHub issues
hugovk Jan 9, 2023
735f044
The mailing list no longer automatically receives bug reports from th…
hugovk Jan 9, 2023
96df81b
Apply suggestions from code review
hugovk Jan 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions documentation/help-documenting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ The in-development and recent maintenance branches are rebuilt once per day.

If you would like to be more involved with documentation, consider subscribing
to the `docs@python.org <https://mail.python.org/mailman3/lists/docs.python.org/>`_
mailing list. The `issue tracker`_ sends new documentation issues to this
mailing list, and, less frequently, the list receives some directly mailed bug
reports. The `docs-sig@python.org <https://mail.python.org/mailman/listinfo/doc-sig>`_
mailing list discusses the documentation toolchain, projects, and standards.
mailing list and the `Documentation category on the Python Discourse
<https://discuss.python.org/c/documentation/26>`_,
where user issues are raised and documentation toolchain, projects, and standards
are discussed.


Helping with documentation issues
Expand All @@ -52,8 +52,9 @@ typos to unclear documentation and items lacking documentation.

If you see a documentation issue that you would like to tackle, you can:

* check to see if there is a paperclip or `octocat`_ icon at the end of the
issue's title column. If there is, then someone has already created a pull
* check to see if there is pull request icon to the right of the issue's title,
or an open pull request listed under :guilabel:`Linked PRs` in the issue body.
If there is, then someone has already created a pull
request for the issue.
* leave a comment on the issue saying you are going to try and create a pull
request and roughly how long you think you will take to do so (this allows
Expand Down