Added file-upload documentation with basic outline of what is provide…

…d and added to index
ckan · Jan 19, 2012 · 8b55590 · 8b55590
1 parent ecfe059
commit 8b55590
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/doc/file-upload.rst b/doc/file-upload.rst
@@ -0,0 +1,19 @@
+============
+File uploads
+============
+
+CKAN allows users to upload files directly to file storage on the CKAN server. The uploaded files will be stored in the configured location.
+
+The important settings for the CKAN .ini file are
+
+::
+
+    storage.bucket = ckan 
+    storage.directory = /data/uploads/
+
+The directory where files will be stored should exist or be created before the system is used.
+
+It is also possible to have uploaded CSV and Excel files stored in the Webstore which provides a structured data store built on a relational database backend.  The configuration of this process is described at `the CKAN wiki <http://wiki.ckan.org/Integrating_CKAN_With_Webstore>`_.
+
+Storing data in the webstore allows for the direct retrieval of the data in a tabular format.  It is possible to fetch a single row of the data, all of the data and have it returned in HTML, CSV or JSON format. More information and the API documentation for the webstore is available at `read the docs
+<http://webstore.readthedocs.org/en/latest/index.html  >`_.
diff --git a/doc/index.rst b/doc/index.rst
@@ -31,6 +31,7 @@ Contents:
    database_dumps
    upgrade
    i18n
+   file-upload
    configuration
    api
    test