Changes between Version 2 and Version 3 of 2020SeasonOfDocs


Ignore:
Timestamp:
Apr 29, 2020, 9:10:46 AM (4 years ago)
Author:
Carlton Gibson
Comment:

Update for 2020 with focus on the contributing guide.

Legend:

Unmodified
Added
Removed
Modified

  • 2020SeasonOfDocs

    v2 v3  
    1 == Google's Season of Docs. 
     1== Google's Season of Docs.
    22
    3 We'd like to participate in Google's Season of Docs.
     3Summer of Code has been a real boon to Django. We'd like to participate too in
     4Google's Season of Docs.
    45
    5 General process would be communications with Fellows, group help on the django-core-mentorship mailing list and more report based emails to the django-developers list.
     6Generally Django's docs are great. So much so that [https://twitter.com/aaronbassett/status/1254601750461534208?s=20 folks send thanks].
    67
    7 Anyone looking to mentor here, please let Carlton and/or Mariusz (current Django Fellows) know.
     8Repeatedly though we've had one observation, that a specialist technical writer could
     9really help us with. The [https://docs.djangoproject.com/en/3.0/internals/contributing/ Contributing Guide] is, frankly, overwhelming.
    810
    9 Possible projects (feel free to add other ideas!):
     11There 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.
    1012
    11 === General targeting of Documentation issues.
     13There'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.
    1214
    13 By component, "Documentation" tickets are our third biggest area (after the ORM and then Admin).
     15We'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.
    1416
    15 [https://code.djangoproject.com/query?status=assigned&status=new&component=Documentation&col=id&col=summary&col=status&col=owner&col=type&col=component&col=version&desc=1&order=id Open Accepted Documentation Issues]
    16 
    17 There are tickets of all types and level here. Many are tutorial like, affecting the template layer or admin or CSRF handling handling and so on. Others are more code-based detailing exact usage points.
    18 
    19 There is plenty of work in both kinds. A general survey to identify related tickets and then address then as groups would be of massive benefit.
    20 
    21 === Integrating with modern JS frameworks How-To.
    22 
    23 This is a more specific project.
    24 
    25 Django's staticfiles app is perfectly capable of working with modern JS frameworks. There's a lack of an up to date guide of exactly How-To on that.
    26 
    27 This has been the topic of much recent discussion:
    28 
    29 * https://code.djangoproject.com/ticket/30296
    30 * https://groups.google.com/forum/#!topic/django-developers/KVAZkRCq9KU
    31 * https://2019.djangocon.eu/talks/take-the-gore-out-of-a-djangoreact-stack/
    32 
    33 Bringing this up to date would be a great addition.
     17Any queries are very welcome on the [https://forum.djangoproject.com Forum contributing channel].
Back to Top