[GMG-Devel] Help extract documentation from my brain

Caleb Davis caldavis at gmail.com
Mon Jul 18 14:39:05 EDT 2011


re: federation use cases:

http://www.w3.org/2005/Incubator/federatedsocialweb/wiki/SWAT0

This use case requires accounts across multiple service types to publicly
interact with each other.

Still in development are more elaborate use cases, including private
interactions:

http://www.w3.org/2005/Incubator/federatedsocialweb/wiki/SWAT1_use_cases

hth, --Caleb

On Sat, Jul 16, 2011 at 4:06 PM, will kahn-greene <willg at bluesock.org>wrote:

> I'd like to see a braindump on how we currently think federation will work
> and what it entails in terms of use cases.  Amongst other things, that's a
> question that comes up periodically on IRC usually in relation to some other
> project.  Having it codified somewhere (if it isn't already [is it?]) would
> be super.
>
>
>
> On 07/16/2011 04:45 PM, Christopher Allan Webber 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!
>>
>>  ______________________________**_________________
> devel mailing list
> devel at mediagoblin.org
> http://lists.mediagoblin.org/**listinfo/devel<http://lists.mediagoblin.org/listinfo/devel>
>



-- 
Caleb
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.mediagoblin.org/pipermail/devel/attachments/20110718/ae1aaabb/attachment.html>


More information about the devel mailing list