Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into 2939-orgs
- Loading branch information
Showing
5 changed files
with
42 additions
and
24 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,35 +1,45 @@ | ||
CKAN is open-source data hub software. CKAN makes it easy to publish, share and | ||
work with data. It's a data management system that provides a powerful platform | ||
for cataloging, storing and accessing datasets with a rich front-end, full API | ||
(for both data and catalog), visualization tools and more. Read more at | ||
http://ckan.org/. | ||
CKAN: The Open Source Data Portal Software | ||
========================================== | ||
|
||
* Installation instructions: see docs at http://docs.ckan.org/ | ||
* Project wiki: http://wiki.ckan.org/ | ||
* Developer mailing list: ckan-dev@lists.okfn.org | ||
* Issue tracker: http://trac.ckan.org/ | ||
**CKAN is the world’s leading open-source data portal platform**. | ||
CKAN makes it easy to publish, share and work with data. It's a data management | ||
system that provides a powerful platform for cataloging, storing and accessing | ||
datasets with a rich front-end, full API (for both data and catalog), visualization | ||
tools and more. Read more at `ckan.org <http://ckan.org/>`_. | ||
|
||
Building Documentation | ||
====================== | ||
|
||
1. Install python-sphinx (>= 1.1) | ||
Installation | ||
------------ | ||
|
||
2. Initialize the theme submodule:: | ||
See the `CKAN Documentation <http://docs.ckan.org>`_ for installation instructions. | ||
|
||
git submodule init | ||
git submodule update | ||
|
||
3. Run the command to build the docs:: | ||
Community | ||
--------- | ||
|
||
* Developer mailing list: `ckan-dev@lists.okfn.org <http://lists.okfn.org/mailman/listinfo/ckan-dev>`_ | ||
* Developer IRC channel: #ckan on `irc.freenode.net <http://freenode.net/>`_ | ||
* Issue tracker: `trac.ckan.org <http://trac.ckan.org/>`_ | ||
* `CKAN tag on StackOverflow <http://stackoverflow.com/questions/tagged/ckan>`_ | ||
|
||
|
||
Contributing to CKAN | ||
-------------------- | ||
|
||
CKAN is a free software project and code contributions are welcome. | ||
The `For CKAN Developers <http://docs.ckan.org/en/latest/index.html#for-ckan-developers>`_ | ||
section of the documentation explains how to contribute to CKAN or its documentation, | ||
including our **coding standards**. | ||
|
||
The `CKAN Wiki <https://github.com/okfn/ckan/wiki>`_ is also open fo contributions. | ||
|
||
python setup.py build_sphinx | ||
|
||
Copying and License | ||
=================== | ||
------------------- | ||
|
||
This material is copyright (c) 2006-2011 Open Knowledge Foundation. | ||
|
||
It is open and licensed under the GNU Affero General Public License (AGPL) v3.0 | ||
whose full text may be found at: | ||
|
||
http://www.fsf.org/licensing/licenses/agpl-3.0.html | ||
|
||
http://www.fsf.org/licensing/licenses/agpl-3.0.html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters