[issue17888] docs: more information on documentation team
New submission from anatoly techtonik: To help people understand that they can actually improve Python docs themselves, how about the following changes: http://docs.python.org/3/bugs.html - rename from "Reporting Bugs" to "Dealing with Bugs". Explain that sometimes fixing bug is easier than reporting, because it involves less time from all people in total. Link to step-by-step documentation for the process and include channel for proposals how to make the process more streamlined. Add links to archive and docs@python.org mailing list info http://mail.python.org/mailman/listinfo/docs On this info page make it clear that "Python documentation team" is not a team in common narrow sense, but a group of volunteers open for everybody. Either by providing a link to team page with listed members, or by replacing the text: - "Mailing list for the Python documentation team" + "Mailing list for people collaborating on Python docs" ---------- assignee: docs@python components: Documentation messages: 188218 nosy: docs@python, techtonik priority: normal severity: normal status: open title: docs: more information on documentation team _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Georg Brandl added the comment: Sounds good, please prepare a patch. ---------- nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
anatoly techtonik added the comment: May take a few days. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Changes by Tshepang Lekhonkhobe <tshepang@gmail.com>: ---------- nosy: +tshepang _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Mark Lawrence added the comment: In recent months people have been doing some great work on the docs, is this something that one of them could pick up? I'm sorry that I can't remember any names. ---------- nosy: +BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- keywords: +easy stage: -> needs patch type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Terry Chia added the comment: Hello, I have attached a patch that should resolve this issue. Do let me know if anything needs fixing as this is my first contribution. ---------- keywords: +patch nosy: +terry.chia Added file: http://bugs.python.org/file35739/issue17888.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Berker Peksag added the comment: issue17888.patch looks good to me. I'd probably remove the "necessary skills" part. ---------- nosy: +berker.peksag stage: needs patch -> patch review versions: +Python 3.5, Python 3.6 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Changes by Mark Lawrence <breamoreboy@yahoo.co.uk>: ---------- nosy: -BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Laura Rupprecht added the comment: I've updated the patch from Terry with Berker's suggestion. ---------- nosy: +laura Added file: http://bugs.python.org/file43162/issue17888_2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Berker Peksag added the comment: Thanks, Laura. I will commit issue17888_2.patch later today. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Roundup Robot added the comment: New changeset 3136c67eac4d by Berker Peksag in branch '3.5': Issue #17888: Add a note about contributing to Python docs https://hg.python.org/cpython/rev/3136c67eac4d New changeset 1f8181e66b36 by Berker Peksag in branch 'default': Issue #17888: Merge from 3.5 https://hg.python.org/cpython/rev/1f8181e66b36 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
Berker Peksag added the comment: Thanks for the patches Terry and Laura. ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue17888> _______________________________________
participants (9)
-
anatoly techtonik -
Berker Peksag
-
Ezio Melotti
-
Georg Brandl
-
Laura Rupprecht
-
Mark Lawrence
-
Roundup Robot
-
Terry Chia
-
Tshepang Lekhonkhobe