Re: [GMG-Devel] [GNU MediaGoblin] #5311: Improve plugin documentation

[Laura Arjona Reina]

Hi everybody
I cannot send comments to the issue in trac, they get rejected:

Submission rejected as potential spam - SpamBayes determined spam
probability of 100.00%

I thought it was because I was including the URL to my branch, but tried
with gitorious dot
org/mediagoblin/larjonas-mediagoblin/source/39bf1cf8e1d9621ba9f1a39df5ec9d350ca787e7

and got the same result.

So I'm sending this to trac by mail (not sure if it works) and to the
list (if the mail submission is disabled or rejected, I hope any of you
can update the issue for me).

----
Hi everybody

In the branch "plugindocs" of my mediagoblin clone at

https://gitorious.org/mediagoblin/larjonas-mediagoblin/source/39bf1cf8e1d9621ba9f1a39df5ec9d350ca787e7:#

I have committed some changes to fix this:

What's done:
*  All the plugins are listed in the docs/index.rst

* For the plugins that had no documentation, now there's a documentation
file, with the corresponding "include" line pointing to the
mediagoblin/plugin/*/README.rst (same as the plugins that were already
documented).

* For the plugins that had no documentation, now there's a README.rst
file with a label, a header and the text "Pending to document."

* For archivalook plugin, now there's a README.rst file with a label, a
header and the text "See README.txt file in your
mediagoblin/plugins/archivalook folder."

Pending work:

* Gather documentation about the plugins (from release notes, wiki or
other places) and complete the corresponding README.rst files

* Convert archivalook/README.txt into archivalook/README.rst (sorry but
I'm not familiarized with restructured text)

* Build the documentation to be sure that everything works (sorry but
the "Sphinx in virtualenv - Texinfo - Emacs" procedure looks too
difficult for me, right now... I appreciate if somebody performs this
task for me)

If I have time, I'll pick the first pending task (gather
documentation...), and I'll update this issue. But I think right now
it's merge-able, too.

Best

Laura Arjona

El 11/04/15 a las 13:03, Trac escribió:
> #5311: Improve plugin documentation
> --------------------------------+------------------------------------
>       Reporter:  larjona        |      Owner:
>           Type:  enhancement    |     Status:  new
>       Priority:  major          |  Milestone:
>      Component:  documentation  |   Keywords:  pllugins documentation
> Parent Tickets:                 |
> --------------------------------+------------------------------------
>  All the available plugins should be listed.
>  List plugins in alphabetical order.
> 
> --
> Ticket URL: <http://issues.mediagoblin.org/ticket/5311>
> GNU MediaGoblin <http://issues.mediagoblin.org/>
> GNU MediaGoblin
> 


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