Opened 4 years ago

Closed 4 years ago

#32412 closed Cleanup/optimization (fixed)

Make contributing guide more accessible.

Reported by: Carlton Gibson Owned by: gabbyprecious
Component: Documentation Version: 3.1
Severity: Normal Keywords:
Cc: Triage Stage: Accepted
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Django was accepted onto 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.

Change History (11)

comment:1 by Carlton Gibson <carlton@…>, 4 years ago

In e733c9a:

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.

comment:2 by Carlton Gibson <carlton@…>, 4 years ago

In aa29c57:

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.

comment:3 by Carlton Gibson <carlton.gibson@…>, 4 years ago

In bbd1b356:

[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

comment:4 by Carlton Gibson <carlton.gibson@…>, 4 years ago

In cb680b68:

[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

comment:5 by Carlton Gibson <carlton.gibson@…>, 4 years ago

In fdeca77:

[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

comment:6 by Carlton Gibson <carlton.gibson@…>, 4 years ago

In 526a6f0d:

[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

comment:7 by Claude Paroz, 4 years ago

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.

comment:8 by Carlton Gibson, 4 years ago

Ok thanks Claude. Further changes only for 3.2.

comment:9 by Carlton Gibson <carlton@…>, 4 years ago

In ead9085f:

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.gibson@…>

comment:10 by Carlton Gibson <carlton.gibson@…>, 4 years ago

In cafabd08:

[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.gibson@…>

Backport of ead9085f0872d5c1c670502df6dc0f69b422eaad from master

comment:11 by Carlton Gibson, 4 years ago

Resolution: fixed
Status: assignedclosed
Note: See TracTickets for help on using tickets.
Back to Top