Skip to content
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.

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

Jump to bottom

Add a 'Contributing to Docs' link at the bottom of docs.python.org #77224

Closed
willingc opened this issue Mar 10, 2018 · 5 comments
Closed

Add a 'Contributing to Docs' link at the bottom of docs.python.org #77224

willingc opened this issue Mar 10, 2018 · 5 comments
Labels
docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@willingc
Copy link
Contributor

BPO 33043
Nosy @ned-deily, @willingc, @JulienPalard, @eamanu, @tirkarthi, @suhearsawho
PRs
  • bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page #12006
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2019-03-29.01:57:26.826>
created_at = <Date 2018-03-10.17:30:28.453>
labels = ['type-feature', 'docs']
title = "Add a 'Contributing to Docs' link at the bottom of docs.python.org"
updated_at = <Date 2019-03-29.01:57:26.826>
user = 'https://github.com/willingc'

    bugs.python.org fields:

    activity = <Date 2019-03-29.01:57:26.826>
actor = 'willingc'
assignee = 'docs@python'
closed = True
closed_date = <Date 2019-03-29.01:57:26.826>
closer = 'willingc'
components = ['Documentation']
creation = <Date 2018-03-10.17:30:28.453>
creator = 'willingc'
dependencies = []
files = []
hgrepos = []
issue_num = 33043
keywords = ['patch']
message_count = 5.0
messages = ['313549', '313552', '313566', '335496', '339090']
nosy_count = 7.0
nosy_names = ['ned.deily', 'docs@python', 'willingc', 'mdk', 'eamanu', 'xtreak', 'suhearsawho']
pr_nums = ['12006']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue33043'
versions = []
    @willingc
    Copy link
    Contributor Author

    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

    @willingc willingc added the docs Documentation in the Doc dir label Mar 10, 2018
    @ned-deily
    Copy link
    Member

    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.

    @willingc
    Copy link
    Contributor Author

    Great suggestion Ned. It would be great to have some links on the bug page too.

    @suhearsawho
    Copy link
    Mannequin

    suhearsawho mannequin commented Feb 14, 2019

    I am available to start working on this bug. Please let me know if any issues, concerns, or suggestions come up! Thank you.

    @eamanu eamanu mannequin added the type-feature A feature request or enhancement label Feb 14, 2019
    @willingc
    Copy link
    Contributor Author

    New changeset 081158e by Carol Willing (Susan Su) in branch 'master':
    bpo-33043: Add a Contributing to Docs link and Update the Found a Bug Page (bpo-12006)
    081158e

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @willingc @ned-deily