Changes between Version 3 and Version 4 of 2020SeasonOfDocs


Ignore:
Timestamp:
Apr 29, 2020, 9:54:30 AM (5 years ago)
Author:
Carlton Gibson
Comment:

Edits from feedback via Will Vincent.

Legend:

Unmodified
Added
Removed
Modified
  • 2020SeasonOfDocs

    v3 v4  
    11== Google's Season of Docs.
    22
    3 Summer of Code has been a real boon to Django. We'd like to participate too in
    4 Google's Season of Docs.
     3Summer of Code has been a real boon to Django over the years, providing major new features. We'd like to also participate in Google's Season of Docs this year.
    54
    65Generally Django's docs are great. So much so that [https://twitter.com/aaronbassett/status/1254601750461534208?s=20 folks send thanks].
    76
    8 Repeatedly though we've had one observation, that a specialist technical writer could
     7Repeatedly we've had one observation, that a specialist technical writer could
    98really help us with. The [https://docs.djangoproject.com/en/3.0/internals/contributing/ Contributing Guide] is, frankly, overwhelming.
    109
    11 There are something like 5 or 6 **thousand** words. It's got everything you need to know. But it's not approachable. Repeatedly, new contributors report that they just can't get going.
     10There are something like 5 or 6 **thousand** words. It's got everything you need to know. But it's not approachable. New contributors report that they just can't get going as a result.
    1211
    13 There's [https://docs.djangoproject.com/en/3.0/internals/contributing/new-contributors/ advice for new contributors], [https://docs.djangoproject.com/en/3.0/internals/contributing/writing-code/submitting-patches/ walkthroughs on submitting a patch], and so on. In theory everything you need to know. But it's not structured in the best way possible. It's clearly not offering the best on-ramp.
     12There's [https://docs.djangoproject.com/en/3.0/internals/contributing/new-contributors/ advice for new contributors], [https://docs.djangoproject.com/en/3.0/internals/contributing/writing-code/submitting-patches/ walkthroughs on submitting a patch], and so on. In theory everything you need to know. But it's clearly not structured in the best way possible. It's clearly not offering the best on-ramp.
    1413
    15 We'd love to encourage more contributors, and more contributors from across the community. A Season of Docs project focused on making Django's Contributing Guide more accessible would go a long way to promoting that goal.
     14We'd love to encourage more contributors from across the community. A Season of Docs project focused on making Django's Contributing Guide more accessible would go a long way to promoting that goal.
    1615
    1716Any queries are very welcome on the [https://forum.djangoproject.com Forum contributing channel].
Back to Top