[GMG-Devel] How to contribute to documentation

[Laura Arjona Reina]

Hi everybody

http://mediagoblin.readthedocs.org has been great help to setup my GNU
MediaGoblin instances. Thank you very much for the software and the
documentation, and the additional help in the IRC channel :)

I've seen the "Core Plugin Documentation part" and now it shows:

Part 2: Core plugin documentation

    flatpagesfile plugin
    sampleplugin
    Trim whitespace plugin
    raven plugin
    basic_auth plugin
    openid plugin
    persona plugin
    ldap plugin

Since I'm trying some plugins in my site, I suppose I can contribute to
the documentation at least listing the current list of plugins, and
maybe writing a bit about the plugins that I'll use in my site.

I'm running 0.7.1 and my plugin folder has, in addition to the files
that are already listed, these ones:

api (is this a plugin? not sure)
metadata_display
archivalook
geolocation
oauth
piwigo
httpapiauth

So my first contribution to the docs would be to list all the plugins,
and in alphabetical order, if nobody points to a better order.

But, how to do that? Do I just contribute as in code, creating my branch
from the "master" branch, and working in the /docs/source folder? or do
I need to make a branch/contribution for each tag?

And about the issue tracker: do I open a ticket "Update core plugins
documentation"? Or one ticket for each plugin?

I will update the wiki page
https://wiki.mediagoblin.org/Documentation_quick_start to reflect what I
learn.

Thanks

-- 
Laura Arjona
https://wiki.debian.org/LauraArjona

signature.asc
Description: OpenPGP digital signature