[Django] #32412: Make contributing guide more accessible.

Django

unread,

Feb 3, 2021, 5:29:18 AM2/3/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------
Reporter: Carlton | Owner: gabbyprecious
Gibson |
Type: | Status: assigned
Cleanup/optimization |
Component: | Version: 3.1
Documentation |
Severity: Normal | Keywords:
Triage Stage: Accepted | Has patch: 0
Needs documentation: 0 | Needs tests: 0
Patch needs improvement: 0 | Easy pickings: 0
UI/UX: 0 |
-------------------------------------+-------------------------------------
Django was accepted onto [https://developers.google.com/season-of-docs
Google's Season of Docs] for 2020.

Gabby Precious was accepted for a project to help make the contributing
guide more accessible.

This is a reference ticket for that.

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

Django

unread,

Feb 4, 2021, 4:33:54 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton@…>):

In [changeset:"aa29c57beea7e8e570f8a597ea806ca3e2b3431d" aa29c57]:
{{{
#!CommitTicketReference repository=""
revision="aa29c57beea7e8e570f8a597ea806ca3e2b3431d"
Refs #32412 -- Adjusted link from tutorial to reference docs.

The writing code index page is a better location for a newer contributor
to
land, than the specific patch guidelines subpage.
}}}

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

Django

unread,

Feb 4, 2021, 4:33:54 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton@…>):

In [changeset:"e733c9ac1746cedc78efabff340379f1c9ee47da" e733c9a]:
{{{
#!CommitTicketReference repository=""
revision="e733c9ac1746cedc78efabff340379f1c9ee47da"
Refs #32412 -- Adjusted beginning of Advice for new contributors.

With the goal of guiding folks to the right destination:

* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.
}}}

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

Django

unread,

Feb 4, 2021, 4:39:13 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"bbd1b3565b943f9ee03d094b6b2cd933573cf02b" bbd1b356]:
{{{
#!CommitTicketReference repository=""
revision="bbd1b3565b943f9ee03d094b6b2cd933573cf02b"
[3.2.x] Refs #32412 -- Adjusted beginning of Advice for new contributors.

With the goal of guiding folks to the right destination:

* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.

Backport of e733c9ac1746cedc78efabff340379f1c9ee47da from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:3>

Django

unread,

Feb 4, 2021, 4:39:14 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"cb680b681913d64642501dafe81704e56abaa4bf" cb680b68]:
{{{
#!CommitTicketReference repository=""
revision="cb680b681913d64642501dafe81704e56abaa4bf"
[3.2.x] Refs #32412 -- Adjusted link from tutorial to reference docs.

The writing code index page is a better location for a newer contributor
to
land, than the specific patch guidelines subpage.

Backport of aa29c57beea7e8e570f8a597ea806ca3e2b3431d from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:4>

Django

unread,

Feb 4, 2021, 4:40:04 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"526a6f0d25335145c91524a0ff47723656ef0c2c" 526a6f0d]:
{{{
#!CommitTicketReference repository=""
revision="526a6f0d25335145c91524a0ff47723656ef0c2c"
[3.1.x] Refs #32412 -- Adjusted link from tutorial to reference docs.

The writing code index page is a better location for a newer contributor
to
land, than the specific patch guidelines subpage.

Backport of aa29c57beea7e8e570f8a597ea806ca3e2b3431d from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:6>

Django

unread,

Feb 4, 2021, 4:40:05 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"fdeca7721565b3173e635b2df69dddc4e4c7a1c0" fdeca77]:
{{{
#!CommitTicketReference repository=""
revision="fdeca7721565b3173e635b2df69dddc4e4c7a1c0"
[3.1.x] Refs #32412 -- Adjusted beginning of Advice for new contributors.

With the goal of guiding folks to the right destination:

* Improved wording of tutorial call-out.
* Added summary of page purpose.
* Added link to Writing code reference doc.

Backport of e733c9ac1746cedc78efabff340379f1c9ee47da from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:5>

Django

unread,

Feb 4, 2021, 11:23:27 AM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Claude Paroz):

It's nice to see improvements! However, unless this fixes errors, could we
refrain from backporting to 3.1.x, as each change will require translators
to work on new translations for the stable docs. What's already committed
is fine, of course.

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:7>

Django

unread,

Feb 4, 2021, 2:54:48 PM2/4/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson):

Ok thanks Claude. Further changes only for 3.2.

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:8>

Django

unread,

Mar 3, 2021, 9:34:16 AM3/3/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton@…>):

In [changeset:"ead9085f0872d5c1c670502df6dc0f69b422eaad" ead9085f]:
{{{
#!CommitTicketReference repository=""
revision="ead9085f0872d5c1c670502df6dc0f69b422eaad"
Refs #32412 -- Adjusted Contributing Guide start page.

* Added headers emphasising Work on the framework vs Join the community
sections, to raise the visibility of the community section.
* Added callouts to three main code/docs/translations areas, linking to
respective start pages.
* Moved some Writing code specific content from the start page to the
Writing code index. This clarifies the start page and adds content to
the
previously empty Writing code index.

Co-authored-by: Carlton Gibson <carlton...@noumenal.es>
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:9>

Django

unread,

Mar 3, 2021, 9:43:44 AM3/3/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Carlton Gibson <carlton.gibson@…>):

In [changeset:"cafabd0859aa2061f10d9fc96df64812f4458e50" cafabd08]:
{{{
#!CommitTicketReference repository=""
revision="cafabd0859aa2061f10d9fc96df64812f4458e50"
[3.2.x] Refs #32412 -- Adjusted Contributing Guide start page.

* Added headers emphasising Work on the framework vs Join the community
sections, to raise the visibility of the community section.
* Added callouts to three main code/docs/translations areas, linking to
respective start pages.
* Moved some Writing code specific content from the start page to the
Writing code index. This clarifies the start page and adds content to
the
previously empty Writing code index.

Co-authored-by: Carlton Gibson <carlton...@noumenal.es>

Backport of ead9085f0872d5c1c670502df6dc0f69b422eaad from master
}}}

--
Ticket URL: <https://code.djangoproject.com/ticket/32412#comment:10>

Django

unread,

Mar 3, 2021, 9:44:35 AM3/3/21

to django-...@googlegroups.com

#32412: Make contributing guide more accessible.
-------------------------------------+-------------------------------------

Reporter: Carlton Gibson | Owner:
Type: | gabbyprecious

Cleanup/optimization | Status: closed
Component: Documentation | Version: 3.1
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------