Merge branch 'master' of github.com:okfn/ckan into 847-new-theming-docs

CONTRIBUTING.rst

@@ -23,7 +23,7 @@ contributions to CKAN.
 
 
 ----------------
-Reporting Issues
+Reporting issues
 ----------------
 
 If you've found a bug in CKAN, open a new issue on CKAN's `GitHub Issues`_ (try
@@ -47,7 +47,7 @@ For contributing translations to CKAN, see
 .. _coding standards:
 
 ----------------
-Coding Standards
+Coding standards
 ----------------
 
 When writing code for CKAN, try to respect our coding standards:
@@ -73,7 +73,7 @@ When writing code for CKAN, try to respect our coding standards:
 
 
 ---------------
-Commit Messages
+Commit messages
 ---------------
 
 Generally, follow the `commit guidelines from the Pro Git book`_:
@@ -106,7 +106,7 @@ Here's an example of a good CKAN commit message::
 
 
 -------------------------------
-Frontend Development Guidelines
+Frontend development guidelines
 -------------------------------
 
 .. toctree::
@@ -128,7 +128,7 @@ Frontend Development Guidelines
 
 
 ---------------------
-Writing Documentation
+Writing documentation
 ---------------------
 
 The quickest and easiest way to contribute documentation to CKAN is to sign up
@@ -151,7 +151,7 @@ the `documentation guidelines <http://docs.ckan.org/en/latest/documentation-guid
 .. _making a pull request:
 
 ---------------------
-Making a Pull Request
+Making a pull request
 ---------------------
 
 Once you've written some CKAN code or documentation, you can submit it for
@@ -232,7 +232,7 @@ This section will walk you through the steps for making a pull request.
 .. _create a pull request on GitHub: https://help.github.com/articles/creating-a-pull-request
 
 
-Merging a Pull Request
+Merging a pull request
 ======================
 
 If you're reviewing a pull request for CKAN, when merging a branch into master:

doc/api.rst

@@ -56,7 +56,7 @@ code that calls the CKAN API.  For example, using the CKAN API your app can:
 
 
 ---------------------
-Making an API Request
+Making an API request
 ---------------------
 
 To call the CKAN API, post a JSON dictionary in an HTTP POST request to one of
@@ -152,7 +152,7 @@ with this Python code::
 
 
 ---------------------------------------------
-Example: Importing Datasets with the CKAN API
+Example: Importing datasets with the CKAN API
 ---------------------------------------------
 
 You can add datasets using CKAN's web interface, but when importing many
@@ -207,7 +207,7 @@ to import datasets into CKAN.
 
 
 ------------
-API Versions
+API versions
 ------------
 
 The CKAN APIs are versioned. If you make a request to an API URL without a
@@ -234,7 +234,7 @@ request that doesn't specify the API version number cannot be relied on.
 .. _api authentication:
 
 ---------------------------
-Authentication and API Keys
+Authentication and API keys
 ---------------------------
 
 Some API functions require authorization. The API uses the same authorization
@@ -268,7 +268,7 @@ run this Python code::
 
 
 ----------------------
-GET-able API Functions
+GET-able API functions
 ----------------------
 
 Functions defined in `ckan.logic.action.get`_ can also be called with an HTTP
@@ -301,7 +301,7 @@ http://demo.ckan.org/api/3/action/term_translation_show?terms=russian&terms=roma
 
 
 -------------
-JSONP Support
+JSONP support
 -------------
 
 To cater for scripts from other sites that wish to access the API, the data can
@@ -315,7 +315,7 @@ http://demo.ckan.org/api/3/action/package_show?id=adur_district_spending&callbac
 .. _api-reference:
 
 --------------------
-Action API Reference
+Action API reference
 --------------------
 
 .. note::

doc/background-tasks.rst

@@ -1,5 +1,5 @@
 ================
-Background Tasks
+Background tasks
 ================
 
 .. version-added: 1.5.1
@@ -18,7 +18,7 @@ for example:
   DataStorer Extensions)
 
 
-Enabling Background Tasks
+Enabling background tasks
 =========================
 
 To manage and run background tasks requires a job queue and CKAN uses celery_
@@ -54,7 +54,7 @@ To run the celery daemon you have two options:
      paster celeryd --config=/path/to/file.ini
 
 
-Writing Background Tasks
+Writing background tasks
 ==========================
 
 These instructions should show you how to write an background task and how to

doc/conf.py

@@ -57,6 +57,8 @@
 .. |sqlalchemy| replace:: SQLAlchemy
 .. |javascript| replace:: JavaScript
 .. |apache| replace:: Apache
+.. |nginx_config_file| replace:: /etc/nginx/sites-available/ckan_default
+.. |reload_nginx| replace:: sudo service nginx reload
 
 .. _Jinja2: http://jinja.pocoo.org/
 .. _CKAN front page: http://127.0.0.1:5000
@@ -91,7 +93,7 @@
     href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons
     Attribution ShareAlike (Unported) v3.0 License</a>.<br />
     <img src="http://i.creativecommons.org/l/by-sa/3.0/80x15.png" alt="CC License Logo" />
-    <a href="http://opendefinition.org/"><img src="http://assets.okfn.org/images/ok_buttons/oc_80x15_blue.png" border="0" 
+    <a href="http://opendefinition.org/"><img src="http://assets.okfn.org/images/ok_buttons/oc_80x15_blue.png" border="0"
       alt="{{ _('Open Content') }}" /></a>
   '''
 html_show_sphinx = False
@@ -150,7 +152,7 @@
 #'sidebarbgcolor': '#F2F2F2',
 #'sidebartextcolor': 'black',
 #'sidebarlinkcolor': '#355F7C',
-#'headfont': 'Trebuchet MS'    
+#'headfont': 'Trebuchet MS'
 #}
 sys.path.append(os.path.abspath('_themes'))
 html_theme_path = ['_themes']

doc/css-coding-standards.rst

@@ -1,4 +1,4 @@
-CSS Coding Standards
+CSS coding standards
 ====================
 
 .. Note::

doc/data-viewer.rst

@@ -205,7 +205,7 @@ from the config. You can find a complete example in the
 
 .. _embed-previews:
 
-Embedding Previews In Other Web Pages
+Embedding previews in other web pages
 -------------------------------------
 
 .. versionchanged:: 2.0

doc/datastore.rst

@@ -1,5 +1,5 @@
 ===================
-DataStore Extension
+DataStore extension
 ===================
 
 
@@ -114,7 +114,7 @@ if necessary, for example:
 Replace ``pass`` with the passwords you created for your |database_user| and
 |datastore_user| database users.
 
-Set Permissions
+Set permissions
 ---------------
 
 .. tip:: See :ref:`legacy-mode` if these steps continue to fail or seem too complicated for your set-up. However, keep in mind that the legacy mode is limited in its capabilities.
@@ -218,6 +218,23 @@ The set-up for legacy mode is analogous to the normal set-up as described above
 
 There is no need for a read-only user or special permissions. Therefore the legacy mode can be used for simple set-ups as well.
 
+.. _datapusher:
+
+---------------------------------------------------
+DataPusher: Automatically Add Data to the DataStore
+---------------------------------------------------
+
+Often, one wants data that is added to CKAN (whether it is linked to or
+uploaded to the :doc:`FileStore <filestore>`) to be automatically added to the
+DataStore. This requires some processing, to extract the data from your files
+and to add it to the DataStore in the format the DataStore can handle.
+
+This task of automatically parsing and then adding data to the DataStore is
+performed by a DataPusher, a service that runs asynchronously and can be installed
+allongside CKAN.
+
+To install this please look at the docs here: http://datapusher.readthedocs.org
+
 
 -----------------
 The DataStore API
@@ -242,15 +259,15 @@ associated CKAN resource. If data is stored in the DataStore, it will automatica
 previewed by the :ref:`recline preview extension <data-explorer>`.
 
 
-Making a DataStore API Request
+Making a DataStore API request
 ==============================
 
 Making a DataStore API request is the same as making an Action API request: you
 post a JSON dictionary in an HTTP POST request to an API URL, and the API also
 returns its response in a JSON dictionary. See the :doc:`api` for details.
 
 
-API Reference
+API reference
 =============
 
 .. note:: Lists can always be expressed in different ways. It is possible to use lists, comma separated strings or single items. These are valid lists: ``['foo', 'bar']``, ``'foo, bar'``, ``"foo", "bar"`` and ``'foo'``. Additionally, there are several ways to define a boolean value. ``True``, ``on`` and ``1`` are all vaid boolean values.
@@ -366,7 +383,7 @@ A resource in the DataStore can have multiple aliases that are easier to remembe
 
 .. _datastore_search_htsql:
 
-HTSQL Support
+HTSQL support
 -------------
 
 
@@ -411,20 +428,3 @@ name
     Contains the name of the alias if alias_of is not null. Otherwise, this is the resource id of the CKAN resource for the DataStore resource.
 oid
     The PostgreSQL object ID of the table that belongs to name.
-
-
-.. _datastorer:
-
----------------------------------------------------
-DataStorer: Automatically Add Data to the DataStore
----------------------------------------------------
-
-Often, one wants data that is added to CKAN (whether it is linked to or
-uploaded to the :doc:`FileStore <filestore>`) to be automatically added to the
-DataStore. This requires some processing, to extract the data from your files
-and to add it to the DataStore in the format the DataStore can handle.
-
-This task of automatically parsing and then adding data to the DataStore is
-performed by a DataStorer, a queue process that runs asynchronously and can be
-triggered by uploads or other activities. The DataStorer is an extension and can
-be found, along with installation instructions, at: https://github.com/okfn/ckanext-datastorer