[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [GMG-Devel] Help extract documentation from my brain
From: |
Christopher Allan Webber |
Subject: |
Re: [GMG-Devel] Help extract documentation from my brain |
Date: |
Sun, 24 Jul 2011 22:09:01 -0500 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) |
I've taken notes to write up docs on these and all other things
mentioned in that thread.
In addition, I've started moving my braindumps here:
http://wiki.mediagoblin.org/User:Cwebber/braindumps
Caleb Davis <address@hidden> writes:
> Perhaps seeing these again will spark a dump or two
> (http://bugs.foocorp.net/issues/262, and http://bugs.foocorp.net/issues/289):
>
> • (WSGI) Application structure
> • Media submission process
> • Media conversion/processing process
> • Multiple media type handling for display/submission/processing and what
> writing extensions for this will look like
> • Maybe a bit about plugins vision but that's not currently critical
> • re:f289 - 'I'll write up a braindump of how all this stuff works to the
> mailing list this week.'
>
> I also wonder about celery, which jobs it performs, and why it's such an
> important component of MediaGoblin's design.
>
> hth, --Caleb
>
> On Sat, Jul 16, 2011 at 3:45 PM, Christopher Allan Webber <address@hidden>
> wrote:
>
> Hi all,
>
> We'd like to improve our documentation. Fortunately, a lot of people on
> our team are coming up to speed with the codebase and have a pretty good
> idea of how things work. Unfortunately a lot of it is in my head, but I
> don't have time to work on nice docs because I need to focus on the
> codebase.
>
> Here's a solution. A lot of the initial documentation was extracted
> from some "braindump" files I wrote and was rewritten by other people
> (largely Will, but also some other volunteers) into something more
> coherent. I think we should do the same thing again.
>
> So over the next few weeks I'm going to braindump about various topics
> on-list. Is there anything mysterious about the codebase or etc that
> you want clarified? Here's a list of topics I think I should braindump
> about, feel free to make more requests:
> - Database stuff
> - Migrations
> - Indexing
> - What are all the fields? (Should add docstrings)
> - How to add new views (including routing)
> - Config stuff
> - Templates
> - General style concerns
> - Testing
> - Storage, and the storage API
> - What is the workbench?
> - ???
>
> Feel free to expand on this, and I'll start braindumping!
>
> --
> http://dustycloud.org/
> _______________________________________________
> devel mailing list
> address@hidden
> http://lists.mediagoblin.org/listinfo/devel
>
> --
> Caleb
>
> _______________________________________________
> devel mailing list
> address@hidden
> http://lists.mediagoblin.org/listinfo/devel
--
http://dustycloud.org/
- Re: [GMG-Devel] Help extract documentation from my brain, (continued)
- Re: [GMG-Devel] Help extract documentation from my brain, will kahn-greene, 2011/07/16
- Re: [GMG-Devel] Help extract documentation from my brain, Vinzenz Vietzke, 2011/07/16
- Re: [GMG-Devel] Help extract documentation from my brain, Odin, 2011/07/17
- Re: [GMG-Devel] Help extract documentation from my brain, Christopher Allan Webber, 2011/07/17
- Re: [GMG-Devel] Help extract documentation from my brain, Caleb Davis, 2011/07/19
- Re: [GMG-Devel] Help extract documentation from my brain,
Christopher Allan Webber <=