Merge branch '1253-moving-user-guides'

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/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.
@@ -259,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.
@@ -383,7 +383,7 @@ A resource in the DataStore can have multiple aliases that are easier to remembe
 
 .. _datastore_search_htsql:
 
-HTSQL Support
+HTSQL support
 -------------
 
 
@@ -428,5 +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.
-
-

doc/deployment.rst

@@ -1,5 +1,5 @@
 ==========================
-Deploying a Source Install
+Deploying a source install
 ==========================
 
 Once you've installed CKAN from source by following the instructions in
@@ -66,7 +66,7 @@ a layer of caching::
     sudo apt-get install nginx
 
 --------------------------
-4. Install an Email Server
+4. Install an email server
 --------------------------
 
 If one isn't installed already, install an email server to enable CKAN's email
@@ -82,7 +82,7 @@ return.
 
 
 ------------------------------
-5. Create the WSGI Script File
+5. Create the WSGI script file
 ------------------------------
 
 Create your site's WSGI script file |apache.wsgi| with the following
@@ -107,7 +107,7 @@ CKAN to run in).
 
 
 --------------------------------
-6. Create the Apache Config File
+6. Create the Apache config file
 --------------------------------
 
 Create your site's Apache config file at |apache_config_file|, with the
@@ -169,7 +169,7 @@ following contents:
 
 
 ------------------------
-8. Enable Your CKAN Site
+8. Enable your CKAN site
 ------------------------
 
 Finally, enable your CKAN site in Apache:
@@ -189,7 +189,7 @@ CKAN instance.
 Troubleshooting
 ---------------
 
-Default Apache Welcome Page
+Default Apache welcome page
 ===========================
 
 If you see a default Apache welcome page where your CKAN front page should be,
@@ -233,7 +233,7 @@ not allowed to write to stdout. Possible solutions include:
 
 Also see https://code.google.com/p/modwsgi/wiki/ApplicationIssues
 
-Log Files
+Log files
 =========
 
 In general, if it's not working look in the log files in ``/var/log/apache2``

doc/email-notifications.rst

@@ -1,7 +1,7 @@
 .. _email-notifications:
 
 ===================
-Email Notifications
+Email notifications
 ===================
 
 CKAN can send email notifications to users, for example when a user has new

doc/getting-started.rst

@@ -1,17 +1,17 @@
 ===============
-Getting Started
+Getting started
 ===============
 
 Once you've finished :doc:`installing CKAN <installing>`, this section
 will walk you through getting started with your new CKAN website, including
-creating a CKAN sysadmin user and some test data, and the basics of
-administering and configuring your CKAN site.
+creating a CKAN sysadmin user, some test data, and the basics of configuring
+your CKAN site.
 
 
 .. _create-admin-user:
 
 ------------------------
-Creating a Sysadmin User
+Creating a sysadmin user
 ------------------------
 
 You have to use CKAN's command line interface to create your first sysadmin
@@ -46,10 +46,12 @@ For a list of other command line commands for managing sysadmins, run::
 
  paster sysadmin --help
 
+Read the :doc:`sysadmin-guide` to learn what you can do as a CKAN sysadmin.
+
 .. _create-test-data:
 
 ------------------
-Creating Test Data
+Creating test data
 ------------------
 
 It can be handy to have some test data to start with, to quickly check that
@@ -67,26 +69,9 @@ For a list of other command line commands for creating tests data, run::
 
  paster create-test-data --help
 
-
---------------
-The Admin Page
---------------
-
-If you login with a sysadmin account (see :ref:`create-admin-user`) you'll see
-a link in the top-right corner of the site to the administration page:
-
-.. image :: images/admin-page.png
-   :align: center
-   :alt: The admin page
-
-From the admin page you can set various CKAN options including the site title
-and logo, the about page text, the intro text on the front page, custom CSS,
-etc.
-
-
----------------
-The Config File
----------------
+-----------
+Config file
+-----------
 
 All of the options that can be set in the admin page and many more can be set
 by editing CKAN's config file. By default, the config file is located at

doc/index.rst

@@ -11,8 +11,12 @@ For high-level information on what CKAN is, see the
 These docs are ordered with the beginner documentation first, and the most
 advanced documentation last:
 
+* :doc:`user-guide` and :doc:`sysadmin-guide` are what most people will need.
+  They explain the CKAN functionalities that **users** and **sysadmins** will
+  encounter when using its web interface.
+
 * :doc:`installing` and :doc:`getting-started` walk you through installing CKAN
-  and setting up your own CKAN site with some basic customizations.  These docs
+  and setting up your own CKAN site with some basic customizations.  These
   are for **sysadmins** who're new to CKAN and want go get started with it.
 
 * The sections under :doc:`features` cover setting up and using CKAN features,
@@ -34,6 +38,8 @@ advanced documentation last:
    :hidden:
    :maxdepth: 2
 
+   user-guide
+   sysadmin-guide
    installing
    upgrading
    getting-started