Ticket #2226 (assigned enhancement) — at Version 3
[super] Refactor and improve documentation (v1.7)
Reported by: | rgrp | Owned by: | rgrp |
---|---|---|---|
Priority: | major | Milestone: | ckan-sprint-2012-03-19 |
Component: | ckan | Keywords: | [2d] [a:1.5d] |
Cc: | Repository: | ckan | |
Theme: | none |
Description (last modified by rgrp) (diff)
Documentation is key to the success of projects!
Move material into main docs from wiki
Create a User Guide
Basic step-by-step on getting started with CKAN (See start on set of slides here e.g. http://blog.thedatahub.org/2012/03/02/tutorial-publish-data-with-the-datahub/)
- Sign up
- Publishing data
- Authorization and workflows
Break into sections
Suggest something like:
# General * Intro * Conceptual Overview * What CKAN helps you do (http://ckan.org/) * FAQ ? (or point to the wiki) # For Administrators * Installation and Setup * Configuration options * Customization - Theming etc * Authorization and Workflows * Storage # For Users (Publishers, Data Wranglers, etc etc) * Walkthrough of publishing a dataset * Storage * API (see Developers section) # CKAN Developers * Domain Model * API * Extensions * i18n CKAN Developers * Buildbot
Change History
Note: See
TracTickets for help on using
tickets.