Ticket #2771 (new enhancement)
Documentation and examples for IDatasetForm and IGroupForm
| Reported by: | seanh | Owned by: | seanh |
|---|---|---|---|
| Priority: | awaiting triage | Milestone: | ckan-v1.8 |
| Component: | ckan | Keywords: | docs |
| Cc: | Repository: | ckan | |
| Theme: | none |
Description
Add minimal, working IDatasetForm and IGroupForm example extensions to core, with tests.
The IDatasetForm example should use tag vocabularies (two birds with one stone)
The IDatasetForm and IGroupForm docs are not very good (and are somewhat spread around different doc chapters), fix them up, and reference the new working examples.
Tab Vocabularies docs should reference IDatasetForm example.
When using convert_to/from_extras() you have to remove any free extras from the form or it won't work, this needs to be documented (in the docstring maybe)
There have been recent changes to the schemas that IDatasetForm and IGroupForm use, make sure the docs are up to date.
Change History
comment:2 Changed 19 months ago by seanh
Branch is here, but not finished yet: https://github.com/okfn/ckan/tree/2750-add-docs-and-examples-for-idatasetform-and-igroupform
I've started working on this on a branch, will get it finished as soon as I can