Ticket #2226 (closed enhancement: fixed)

Opened 2 years ago

Last modified 2 years ago

[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/)

  • Publishing data
  • Authorization and workflows
    • Publisher Profile (Workflow)

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

comment:1 Changed 2 years ago by rgrp

  • Milestone changed from ckan-v1.7 to current-ckan-sprint-2012-03-19

comment:2 Changed 2 years ago by rgrp

  • Owner set to rgrp
  • Status changed from new to assigned

comment:3 Changed 2 years ago by rgrp

  • Description modified (diff)

comment:4 Changed 2 years ago by rgrp

  • Description modified (diff)

comment:5 Changed 2 years ago by rgrp

  • Description modified (diff)

comment:6 Changed 2 years ago by seanh

These deployment docs seem worth moving into sphinx as well: ​http://wiki.ckan.org/Deployment

comment:7 Changed 2 years ago by rgrp

  • Status changed from assigned to closed
  • Resolution set to fixed

All done (as of Tuesday in fact!). No doubt further work to do but that's a new ticket!

comment:8 Changed 2 years ago by rgrp

  • Keywords [2d] [a:1.5d] added
Note: See TracTickets for help on using tickets.