[issue33043] Add a 'Contributing to Docs' link at the bottom of docs.python.org
New submission from Carol Willing <willingc@gmail.com>: Adding a 'Contributing to Docs' link at the bottom of the docs.python.org page between 'Reporting bugs' and 'About Documentation'. This could link to the devguide section on contributing to docs or provide a short paragraph including: - the importance of CPython docs as well as other Python projects (warehouse, popular libraries, etc.) - link to the devguide and its section on documentation - link to the core mentorship mailing list - link to docs mailing list As an example, the Rust project's Docs-Contributing page is a good start: https://www.rust-lang.org/en-US/contribute-docs.html ---------- assignee: docs@python components: Documentation messages: 313549 nosy: docs@python, willingc priority: normal severity: normal stage: needs patch status: open title: Add a 'Contributing to Docs' link at the bottom of docs.python.org _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Ned Deily <nad@python.org> added the comment: That's a good idea. I see that there is already a "Found a bug?" link at the bottom of each doc page and that links to a page like: https://docs.python.org/3/bugs.html and that page has a Documentation Bugs section. Perhaps adding a link or two in there would help. ---------- nosy: +ned.deily _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Carol Willing <willingc@gmail.com> added the comment: Great suggestion Ned. It would be great to have some links on the bug page too. ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Change by Karthikeyan Singaravelan <tir.karthi@gmail.com>: ---------- nosy: +xtreak _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Susan Su <susansu.software@gmail.com> added the comment: I am available to start working on this bug. Please let me know if any issues, concerns, or suggestions come up! Thank you. ---------- nosy: +suhearsawho _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Change by Emmanuel Arias <emmanuelarias30@gmail.com>: ---------- nosy: +eamanu type: -> enhancement _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Change by Susan Su <susansu.software@gmail.com>: ---------- keywords: +patch pull_requests: +12037 stage: needs patch -> patch review _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Change by Ned Deily <nad@python.org>: ---------- nosy: +mdk _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Carol Willing <willingc@gmail.com> added the comment: New changeset 081158e3ba20dfa95d09cd652a44e271b95eb14c by Carol Willing (Susan Su) in branch 'master': bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (#12006) https://github.com/python/cpython/commit/081158e3ba20dfa95d09cd652a44e271b95... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
Change by Carol Willing <willingc@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue33043> _______________________________________
participants (5)
-
Carol Willing -
Emmanuel Arias
-
Karthikeyan Singaravelan
-
Ned Deily
-
Susan Su