[ckan-dev] Documentation todo list for 2.0 release

Wed Mar 6 14:56:55 UTC 2013

> I don't suppose there is any chance of standardising the docs for plugins,
> so that they all look the same - it might encourage better documentation for
> the plugins themselves if they had a template to work from?

An advantage of having the plugins' docs in the core docs would be
that they'd all look the same and they would all take advantage of
Sphinx features like the printable PDF version etc.

But I'm guessing you probably mean that each plugins' README file
should have the same basic structure: Installation, Usage, etc. It's
an excellent suggestion. We could have atemplate git repo that we
clone when we want to make a new plugin that would include this and
also the basic source-code layout (or we just update the output of the
paster make-extension command to include a README with section
titles..)