Opened 9 years ago

Closed 9 years ago

#26358 closed Cleanup/optimization (needsinfo)

link in new contributor guide is unclear and needs some improvements

Reported by: Becka R. Owned by: nobody
Component: Uncategorized Version: 1.9
Severity: Normal Keywords: documentation
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: yes UI/UX: no

Description

On this page: https://docs.djangoproject.com/en/1.9/internals/contributing/new-contributors/

"Report bugs in our ticket tracker."

"Report bugs" brings you to the page on bug reporting. It would be useful to include a description of standards for improving and reorganizing documentation.

"ticket tracker' links to this page: https://code.djangoproject.com/newticket. It's behind a login, and could be confusing. Instead, include instructions for creating an account via github or by creating an account.


Change History (2)

comment:1 by Tim Graham, 9 years ago

  1. I don't see the quoted text -- closest is "Report bugs with Django or Django documentation in our ticket tracker" in the sidebar. Is that what you meant? There is a section "Write some documentation" on the new contributors page with links to some guidelines. Please clarify what you found confusing. It might be a case where removing some duplicated information is better than adding more information.
  1. This issue is tracked in https://github.com/django/djangoproject.com/issues/533.

As an aside for future reference, please try to limit each ticket to one item, otherwise it's difficult to see what has been done and what still needs to be done.

comment:2 by Tim Graham, 9 years ago

Resolution: needsinfo
Status: newclosed

Feel free to submit a patch with clarifications, otherwise I'm not sure what improvements should be made. Thanks!

Note: See TracTickets for help on using tickets.
Back to Top