[ckan-changes] [okfn/ckan] 09407b: [#534] Update configuration flags' documentation

GitHub noreply at github.com
Tue Apr 30 13:36:25 UTC 2013


  Branch: refs/heads/release-v2.0
  Home:   https://github.com/okfn/ckan
  Commit: 09407bdc7a47b6bb824636eff10d97cbb252a153
      https://github.com/okfn/ckan/commit/09407bdc7a47b6bb824636eff10d97cbb252a153
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Update configuration flags' documentation

Conflicts:

	doc/configuration.rst


  Commit: 5e954a2b918382b69b6fe1954e349c52c51991b2
      https://github.com/okfn/ckan/commit/5e954a2b918382b69b6fe1954e349c52c51991b2
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Reorganize configuration flags' order in the docs


  Commit: 1c7efc96e09e83b2f75896a2ac04e313b30d73b3
      https://github.com/okfn/ckan/commit/1c7efc96e09e83b2f75896a2ac04e313b30d73b3
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst
    M doc/email-notifications.rst
    M doc/filestore.rst
    M doc/solr-setup.rst

  Log Message:
  -----------
  [#534] Add documentation for some configuration flags


  Commit: b3659659ea3489c2a73eeb569c102171d7e364fd
      https://github.com/okfn/ckan/commit/b3659659ea3489c2a73eeb569c102171d7e364fd
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Remove useless indexes in configuration page


  Commit: 30b5cc4694b2bc5d75db134a33899e32fe3a5ef6
      https://github.com/okfn/ckan/commit/30b5cc4694b2bc5d75db134a33899e32fe3a5ef6
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Minor styling adjustements

Conflicts:

	doc/configuration.rst


  Commit: af56c4e3acb2f2c91cfc15b7d70fe89e13d8e73f
      https://github.com/okfn/ckan/commit/af56c4e3acb2f2c91cfc15b7d70fe89e13d8e73f
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/configuration.rst
    M test-core.ini

  Log Message:
  -----------
  [#534] Remove unused configuration flags


  Commit: 8a974ef7d2fc749dac6a8295c3128c8ba6c51508
      https://github.com/okfn/ckan/commit/8a974ef7d2fc749dac6a8295c3128c8ba6c51508
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst
    M doc/i18n.rst

  Log Message:
  -----------
  [#534] Document some undocumented config options

The added options are:

  ckan.tracking_enabled
  search.facet.limits
  ckan.root_path
  ckan.site_intro_text


  Commit: ad36ccce0e94540c099165f60c0da4eeeae35309
      https://github.com/okfn/ckan/commit/ad36ccce0e94540c099165f60c0da4eeeae35309
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst
    M doc/email-notifications.rst
    M doc/tracking.rst

  Log Message:
  -----------
  [#534] Add E-mail Settings section and add cross-references to the config options.


  Commit: 4eddfd96f46a20499792d2a72cfbfd9848b766af
      https://github.com/okfn/ckan/commit/4eddfd96f46a20499792d2a72cfbfd9848b766af
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Remove legacy config options

These ones are no longer used and will just confuse:

* package_form
* carrot_messaging_library
* amqp_hostname & amqp_port & amqp_user_id & amqp_password
* ckan.log_dir
* ckan.dump_dir
* ckan.backup_dir

Also some minor formatting fixes.

Conflicts:

	doc/configuration.rst


  Commit: c495c2e671cece0a7aee6bdcc8358cd22f135b06
      https://github.com/okfn/ckan/commit/c495c2e671cece0a7aee6bdcc8358cd22f135b06
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Rearrange sections and items

Sections rearranged by importance/usage and items put to their relevant
one.
Sections are now:

 *General Settings
 * Database Settings
 * Site Settings
 * Search Settings
 * Plugin Settings
 * Front-End Settings
 * Theming Settings
 * Activity Streams Settings
 * Feeds Settings
 * Internationalisation Settings
 * Storage Settings
 * Form Settings
 * E-mail Settings

Conflicts:

	doc/configuration.rst


  Commit: ab3f7540b999182669ffc0fd6d439eb8c67172fc
      https://github.com/okfn/ckan/commit/ab3f7540b999182669ffc0fd6d439eb8c67172fc
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/authorization.rst
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Move authorization setting to config options docs

They are one of the most important ones and they should be found on the
conguration options docs. To avoid duplicating them the include rst
directive is used:

.. include:: /configuration.rst
   :start-after: start_config-authorization
   :end-before: end_config-authorization

This requires setting the two markers on the imported file, eg:

.. start_config-authorization

    ... stuff to include ...

.. end_config-authorization


  Commit: 6505ae7c17ed2639e593ea8c59327ac5e6fa2eee
      https://github.com/okfn/ckan/commit/6505ae7c17ed2639e593ea8c59327ac5e6fa2eee
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/apps-ideas.rst
    M doc/configuration.rst
    M doc/email-notifications.rst
    M doc/i18n.rst
    M doc/solr-setup.rst
    M doc/tracking.rst

  Log Message:
  -----------
  [#534] Make reST labels for config settings consistent

Make the reST label for cross-referencing each config setting the same
as the name of the config setitng itself, e.g.
ckan.activity_streams_email_notifications, don't mix and match different
styles of ., _ and - like ckan-activity-streams-email-notifications,
ckan_activity_streams_email_notifications, etc.


  Commit: be0bda9221db98fd35f845950c12c8c817cf3d8a
      https://github.com/okfn/ckan/commit/be0bda9221db98fd35f845950c12c8c817cf3d8a
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst
    M doc/form-integration.rst

  Log Message:
  -----------
  [#534] Add reST labels to all config options

Now we can easily cross-reference any config option from any file in
docs/.


  Commit: d437fca813ef544076c68cf313994a28fc82d506
      https://github.com/okfn/ckan/commit/d437fca813ef544076c68cf313994a28fc82d506
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Edit top of configuration docs page

Use the default ini file locations; Clarify what the [app:main] section
is; say "restart webserver" not Apache, webserver may not be Apache.


  Commit: 37312012889a3bbe7767caec87f7089e7701cb1c
      https://github.com/okfn/ckan/commit/37312012889a3bbe7767caec87f7089e7701cb1c
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Use .. deprecated:: in config docs


  Commit: bfd669fde2b37eb859faca25316329e82b109e09
      https://github.com/okfn/ckan/commit/bfd669fde2b37eb859faca25316329e82b109e09
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Document ckan.template_title_deliminater


  Commit: bdbe19c6f825ee1294b402dbf77a2362303f0a5e
      https://github.com/okfn/ckan/commit/bdbe19c6f825ee1294b402dbf77a2362303f0a5e
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Calm down over-the-top warning


  Commit: bb4baccbdbc4b9ee69cf27c41dc2863f702e4331
      https://github.com/okfn/ckan/commit/bb4baccbdbc4b9ee69cf27c41dc2863f702e4331
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Fix some formatting issues in the docs


  Commit: 2bbc70e84d479144475af3a9146cd35ef554887e
      https://github.com/okfn/ckan/commit/2bbc70e84d479144475af3a9146cd35ef554887e
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Docs correction: template_footer_end is not legacy

Appears in jinja templates


  Commit: 930a54f0dfb06e7b11d43dd17efa0c19aaf0e461
      https://github.com/okfn/ckan/commit/930a54f0dfb06e7b11d43dd17efa0c19aaf0e461
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Update ckan.site_url docs

This is used by much more than just the API


  Commit: e8bb3087e3e20e55b34eed1bf70764e3f5b549a8
      https://github.com/okfn/ckan/commit/e8bb3087e3e20e55b34eed1bf70764e3f5b549a8
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Typo


  Commit: 812441daa77358a401c073cc058958ecd1451b55
      https://github.com/okfn/ckan/commit/812441daa77358a401c073cc058958ecd1451b55
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Docs: correct default value fopr ckan.cache_expires


  Commit: 9cd8fbacb0ed75f21223f76f5e8206d7dea3e3b2
      https://github.com/okfn/ckan/commit/9cd8fbacb0ed75f21223f76f5e8206d7dea3e3b2
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Correct ckan.page_cache_enabled

Fix typos, and mark the feature as experimental


  Commit: 42589d98c9d1f9ef5ecc6e60ee44222b7ec8f9d9
      https://github.com/okfn/ckan/commit/42589d98c9d1f9ef5ecc6e60ee44222b7ec8f9d9
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Typo


  Commit: e7d15c7144e846ffd81e75192b75bd0245a0e297
      https://github.com/okfn/ckan/commit/e7d15c7144e846ffd81e75192b75bd0245a0e297
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Fix ckan.plugins docs

It's a list of plugins, not a list of extensions


  Commit: e13e809b212c730be2cdca7df7503d15c8c11eaf
      https://github.com/okfn/ckan/commit/e13e809b212c730be2cdca7df7503d15c8c11eaf
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-04-30 (Tue, 30 Apr 2013)

  Changed paths:
    M doc/configuration.rst

  Log Message:
  -----------
  [#534] Fix a couple of formatting issues in docs


Compare: https://github.com/okfn/ckan/compare/b95293fd4092...e13e809b212c


More information about the ckan-changes mailing list