Opened 13 years ago

Closed 3 years ago

#248 closed task (fixed)

Tutorial of the codebase documentation in wiki

Reported by: Christopher Allan Webber Owned by:
Priority: minor Milestone:
Component: documentation Keywords:
Cc: Parent Tickets:

Description (last modified by Christopher Allan Webber)

If you're a new programmer, where does everything fit? We should
have a nice guide to this!
One thing we need is a tutorial of sorts for programmers.

This guide should describe just very generally:


-  the routing
-  the views
-  the templates
-  the forms
-  the database/models

... and point to other pages for more specific information :)

(A good strategy might be to do a "walkthrough" of one of the
existing, clearly developed and simple views, from start to finish,
which uses all these pieces?)



Change History (13)

comment:1 by Christopher Allan Webber, 12 years ago

Milestone: 0.1.00.2.0

comment:1 by Christopher Allan Webber, 12 years ago

Owner: set to Christopher Webber
I'm assigning this to myself as it should probably be me who does
this, as I've been the one to lay out the design of the
application. However, Elrond, gullydwarf, joar would all be great
candidates, so adding them as watchers. If someone wants to jump on
this I won't object, otherwise else I'll assume I should do it.



comment:2 by Christopher Allan Webber, 12 years ago

Milestone: 0.2.00.2.1

comment:2 by Will Kahn-Greene, 12 years ago

The original url for this bug was http://bugs.foocorp.net/issues/579 .

comment:3 by Christopher Allan Webber, 12 years ago

Description: modified (diff)

This should definitely happen before Google Summer of Code 2012, assuming that happens.

comment:4 by Christopher Allan Webber, 12 years ago

Milestone: 0.2.10.2.2

comment:5 by Christopher Allan Webber, 12 years ago

Milestone: 0.3.0

As much as I'd love it to, not gonna be done by 0.3.0

comment:6 by Christopher Allan Webber, 11 years ago

Priority: minorcritical

comment:7 by Christopher Allan Webber, 11 years ago

Priority: criticalmajor

comment:8 by Christopher Allan Webber, 11 years ago

Owner: Christopher Allan Webber removed
Status: acceptedassigned

I'm unclaiming this ticket, though I'd like to work on it (and have been slowly improving things). There's a new developer zone section of our docs. If someone's interested in helping add tutorials here, I'm interested in talking about it!

http://docs.mediagoblin.org/#part-4-developer-s-zone

comment:9 by Christopher Allan Webber, 11 years ago

Status: assignedaccepted

comment:10 by Jessica Tallon, 9 years ago

Priority: majorminor

I am changing the priority of this from major to minor. While I agree this would be great to have I just don't think it's as important as a lot of other issues on the tracker which really need people's attention. Don't let it being minor deter people from working on it though, if this is something someone wants to do, work on this issue would be greatly appreciated.

comment:11 by Ben Sturmfels, 3 years ago

Resolution: fixed
Status: acceptedclosed

We have some documentation in docs/devel/codebase.rst, which at least partly covers this.

Note: See TracTickets for help on using tickets.