#20910: Documentation incomplete or misleading(?)
-------------------------------+--------------------------------------
Reporter: jggramlich@… | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.5
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Comment (by mjtamlyn):
I think the big problem here is trying to provide a tutorial which is
ideal for everyone is incredibly hard. To cover, say, an experienced
developer in an alternative MVC technology (e.g. Rails, CakePHP etc)
without being condescending, and to also cover a complete newbie developer
is very challenging.
That said, some of your points are worth considering. It would be nice if
the actual file was mentioned in a consistent way with each code snippet.
The other comments personally I'm not so sure - it'd be verging on
becoming over verbose.
I don't think the docs or the tutorial should be a wiki. It's harder to
maintain quality and we don't have the resources to monitor for spamming.
As for contributing, you probably want to start here:
https://docs.djangoproject.com/en/dev/internals/contributing/writing-
documentation/
--
Ticket URL: <https://code.djangoproject.com/ticket/20910#comment:5>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to django-updates+unsubscr...@googlegroups.com.
To post to this group, send email to django-updates@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/078.8bcab5d8b779f860d75d52f3fcf8a9b2%40djangoproject.com?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
