Ticket #2226 (new enhancement) — at Initial Version

Opened 2 years ago

Last modified 2 years ago

[super] Refactor and improve documentation (v1.7)

Reported by: rgrp Owned by:
Priority: major Milestone: ckan-sprint-2012-03-19
Component: ckan Keywords: [2d] [a:1.5d]
Cc: Repository: ckan
Theme: none

Description

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: 

# For Administrators

* Installation and Setup
  * Configuration options
* Customization - Theming etc
* Authorization and Workflows
* Storage

# For Users (Publishers, Data Wranglers, etc etc)

* Storage
* API (see Developers section)

# CKAN Developers

* API
* Extensions
* i18n

CKAN Developers
* Buildbot
Note: See TracTickets for help on using tickets.