Skip to content

Commit

Permalink
[#1253] Fix a few section titles' capitalization
Browse files Browse the repository at this point in the history
  • Loading branch information
vitorbaptista committed Oct 15, 2013
1 parent 28ad8c1 commit f1ffdb2
Show file tree
Hide file tree
Showing 9 changed files with 39 additions and 40 deletions.
14 changes: 7 additions & 7 deletions CONTRIBUTING.rst
Expand Up @@ -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
Expand All @@ -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:
Expand All @@ -69,7 +69,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`_:
Expand Down Expand Up @@ -102,7 +102,7 @@ Here's an example of a good CKAN commit message::


-------------------------------
Frontend Development Guidelines
Frontend development guidelines
-------------------------------

.. toctree::
Expand All @@ -124,7 +124,7 @@ Frontend Development Guidelines


---------------------
Writing Documentation
Writing documentation
---------------------

The quickest and easiest way to contribute documentation to CKAN is to sign up
Expand All @@ -147,7 +147,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
Expand Down Expand Up @@ -228,7 +228,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:
Expand Down
14 changes: 7 additions & 7 deletions doc/api.rst
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand All @@ -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::
Expand Down
6 changes: 3 additions & 3 deletions doc/background-tasks.rst
@@ -1,5 +1,5 @@
================
Background Tasks
Background tasks
================

.. version-added: 1.5.1
Expand All @@ -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_
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/css-coding-standards.rst
@@ -1,4 +1,4 @@
CSS Coding Standards
CSS coding standards
====================

.. Note::
Expand Down
2 changes: 1 addition & 1 deletion doc/data-viewer.rst
Expand Up @@ -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
Expand Down
12 changes: 6 additions & 6 deletions doc/datastore.rst
@@ -1,5 +1,5 @@
===================
DataStore Extension
DataStore extension
===================


Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -242,15 +242,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.
Expand Down Expand Up @@ -366,7 +366,7 @@ A resource in the DataStore can have multiple aliases that are easier to remembe

.. _datastore_search_htsql:

HTSQL Support
HTSQL support
-------------


Expand Down Expand Up @@ -416,7 +416,7 @@ oid
.. _datastorer:

---------------------------------------------------
DataStorer: Automatically Add Data to the DataStore
DataStorer: Automatically add data to the DataStore
---------------------------------------------------

Often, one wants data that is added to CKAN (whether it is linked to or
Expand Down
14 changes: 7 additions & 7 deletions 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
Expand Down Expand Up @@ -55,7 +55,7 @@ support to Apache)::


--------------------------
3. Install an Email Server
3. Install an email server
--------------------------

If one isn't installed already, install an email server to enable CKAN's email
Expand All @@ -71,7 +71,7 @@ return.


------------------------------
4. Create the WSGI Script File
4. Create the WSGI script file
------------------------------

Create your site's WSGI script file |apache.wsgi| with the following
Expand All @@ -96,7 +96,7 @@ CKAN to run in).


--------------------------------
5. Create the Apache Config File
5. Create the Apache config file
--------------------------------

Create your site's Apache config file at |apache_config_file|, with the
Expand Down Expand Up @@ -130,7 +130,7 @@ requests to your CKAN instance.


------------------------
6. Enable Your CKAN Site
6. Enable your CKAN site
------------------------

Finally, enable your CKAN site in Apache:
Expand All @@ -148,7 +148,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,
Expand Down Expand Up @@ -192,7 +192,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``
Expand Down
2 changes: 1 addition & 1 deletion 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
Expand Down
13 changes: 6 additions & 7 deletions doc/getting-started.rst
@@ -1,5 +1,5 @@
===============
Getting Started
Getting started
===============

Once you've finished :doc:`installing CKAN <installing>`, this section
Expand All @@ -11,7 +11,7 @@ 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
Expand Down Expand Up @@ -51,7 +51,7 @@ 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
Expand All @@ -69,10 +69,9 @@ For a list of other command line commands for creating tests data, run::

paster create-test-data --help


---------------
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
Expand Down

0 comments on commit f1ffdb2

Please sign in to comment.