okfn/ckan — pull request #943 by seanh (2013-06-12 15:27:40+00:00)
Title: Better docs for writing extensions

Our current docs for writing extensions aren't very useful. They could do with being rewritten, possibly with a structure along these lines:

1. Overview (introduce key concepts)
2. Tutorial (step-by-step tutorial for developing an example extension, using a real working example, no assumed knowledge, no steps missing)
3. Troubleshooting
4 Best practices
5. Reference

Issues to cover:

* How to do i18n for extensions
* How to do tests for extensions

Somewhere we also want to fit in the guidelines.

Related issues:

*
*
*
*
*

Note that pretty much all of the reference docs for every plugin interface need rewriting for clarity and detail, and almost all of the plugin interfaces need example plugins and tests. This is a big job and I suggest making a separate github issue for each plugin interface. But finish this ticket first.