CKAN - the Open Source Data Hub Software
Publish, share and find and manage data

General

New to CKAN? Start here.

• Official site for CKAN: http://ckan.org/
• FAQ

User Guide

How to use the CKAN web front-end.

• Using the Web Interface - 2m guide
• Managing Data Packages - On registering & deleting data packages, removing spam, tagging conventions & package resources.
• Searching Packages
• Creating and editing Packages
  • Package Schema - see Domain Model
• Atom Feeds
• Administrative Dashboard
• RDF and CKAN

Advanced Topics

Use CKAN programmatically through the API or scripts.

• The API
  • API Tutorial

System Administrator Guide

The Admin Guide provides a full guide to installing, configuring and running a CKAN site. Advanced topics also include developing CKAN extensions and customizing forms.

Additional background material for administrators:

• List of Extensions - full list of CKAN extensions
  • Geospatial Capabilities
  • Storage
  • Webstore
  • Solr Search
• Deployment - notes on deployment, currently experimental, to be moved into the Admin Guide
  • Farm Deployment
• Workflows - support for various workflows in CKAN (from wiki-like to sysadmin-only)
• Recipes - e.g. tag cloud, configuring google analytics
• Theming1.5 - Customising the look of CKAN v1.5
• Postgres permissions
• Integrating Webstore and CKAN

Community

Get involved in CKAN development.

• Meetups
• Project Steering Committee
• People
• List of all CKAN instances
• Linked Data
• Ideas for CKAN screencasts
• Related components:
  • Webstore maintains tabular data
  • Helmut the reconciliation server
  • datapatterns.org, a data wrangling handbook

Plans

• Documentation Plans
• UX Plans
• Proposals
  • Data Storage Proposal - cf Storage
  • Dataset and Resource Pages Proposal
• Old designs

Technical Background

For developers working on CKAN core - technical background to the CKAN software.

• Design and Architecture
• Domain Model
• User Stories
• Load Testing - notes on how we load tested CKAN
• Purpose
• Data Formats - review of existing data exchange and querying formats
• Related Software - software related to CKAN (e.g. useful tools, similar software etc)

Developer Resources

Practical resources for CKAN developers.

• Submitting a code patch
• Becoming a CKAN Developer - how to get the code, how to contribute (coding standards etc)
  • Source Code Repository (github)
• Making changes to model code - What to be aware of
• Development Overview - Roadmaps etc
• User Stories Spreadsheet
• CKAN developer trac - Tickets
• Release process