[Django] #26358: link in new contributor guide is unclear and needs some improvements

22 views
Skip to first unread message

Django

unread,
Mar 15, 2016, 4:35:40 PM3/15/16
to django-...@googlegroups.com
#26358: link in new contributor guide is unclear and needs some improvements
--------------------------------------+---------------------------
Reporter: beckastar | Owner: nobody
Type: Cleanup/optimization | Status: new
Component: Uncategorized | Version: 1.9
Severity: Normal | Keywords: documentation
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 1 | UI/UX: 0
--------------------------------------+---------------------------
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.

--
Ticket URL: <https://code.djangoproject.com/ticket/26358>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Mar 15, 2016, 6:44:44 PM3/15/16
to django-...@googlegroups.com
#26358: link in new contributor guide is unclear and needs some improvements
-------------------------------------+-------------------------------------
Reporter: beckastar | Owner: nobody
Type: | Status: new
Cleanup/optimization |
Component: Uncategorized | Version: 1.9
Severity: Normal | Resolution:

Keywords: documentation | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timgraham):

* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0


Comment:

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.

2. 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.

--
Ticket URL: <https://code.djangoproject.com/ticket/26358#comment:1>

Django

unread,
Mar 17, 2016, 8:54:24 AM3/17/16
to django-...@googlegroups.com
#26358: link in new contributor guide is unclear and needs some improvements
-------------------------------------+-------------------------------------
Reporter: beckastar | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Uncategorized | Version: 1.9
Severity: Normal | Resolution: needsinfo

Keywords: documentation | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by timgraham):

* status: new => closed
* resolution: => needsinfo


Comment:

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

--
Ticket URL: <https://code.djangoproject.com/ticket/26358#comment:2>

Reply all
Reply to author
Forward
0 new messages