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

GitHub noreply at github.com
Fri Apr 26 19:02:52 UTC 2013


  Branch: refs/heads/534-update-config-options-docs
  Home:   https://github.com/okfn/ckan
  Commit: f8c122723f8de4d986c0b88a2a563f9570212360
      https://github.com/okfn/ckan/commit/f8c122723f8de4d986c0b88a2a563f9570212360
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-03-27 (Wed, 27 Mar 2013)

  Changed paths:
    M doc/configuration.rst

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


  Commit: 5621e48c89a22983fbae95651254cbbb9fba550e
      https://github.com/okfn/ckan/commit/5621e48c89a22983fbae95651254cbbb9fba550e
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-03-27 (Wed, 27 Mar 2013)

  Changed paths:
    M doc/configuration.rst

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


  Commit: 3c5130e45b690625c9a317d33c74fb2482529a8c
      https://github.com/okfn/ckan/commit/3c5130e45b690625c9a317d33c74fb2482529a8c
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-22 (Mon, 22 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: 3153b2ee3cd755a70274a696d97a124d5242987d
      https://github.com/okfn/ckan/commit/3153b2ee3cd755a70274a696d97a124d5242987d
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-22 (Mon, 22 Apr 2013)

  Changed paths:
    M doc/configuration.rst

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


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

  Changed paths:
    M doc/configuration.rst

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


  Commit: b6e4daec4274a4d7dd113d6b5022040db9e04600
      https://github.com/okfn/ckan/commit/b6e4daec4274a4d7dd113d6b5022040db9e04600
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-22 (Mon, 22 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: 62a39b86b42964a2e89165ab564ff5cb55b7a995
      https://github.com/okfn/ckan/commit/62a39b86b42964a2e89165ab564ff5cb55b7a995
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-25 (Thu, 25 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: 92352062968b9866338a1cf14a85b9af74d492a5
      https://github.com/okfn/ckan/commit/92352062968b9866338a1cf14a85b9af74d492a5
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-25 (Thu, 25 Apr 2013)

  Changed paths:
    M CONTRIBUTING.rst
    M README.rst
    M bin/osx-postgres-mem.sh
    M bin/travis-build
    M ckan/config/deployment.ini_tmpl
    M ckan/config/environment.py
    M ckan/config/routing.py
    M ckan/controllers/api.py
    M ckan/controllers/error.py
    M ckan/controllers/feed.py
    M ckan/controllers/group.py
    M ckan/controllers/home.py
    M ckan/controllers/organization.py
    M ckan/controllers/package.py
    M ckan/controllers/related.py
    M ckan/controllers/revision.py
    M ckan/controllers/storage.py
    M ckan/controllers/tag.py
    M ckan/controllers/user.py
    M ckan/i18n/check_po_files.py
    M ckan/lib/activity_streams.py
    M ckan/lib/alphabet_paginate.py
    M ckan/lib/app_globals.py
    M ckan/lib/base.py
    M ckan/lib/cli.py
    M ckan/lib/create_test_data.py
    M ckan/lib/dictization/model_dictize.py
    M ckan/lib/dictization/model_save.py
    M ckan/lib/email_notifications.py
    M ckan/lib/formatters.py
    M ckan/lib/helpers.py
    M ckan/lib/mailer.py
    M ckan/lib/navl/dictization_functions.py
    M ckan/lib/navl/validators.py
    M ckan/lib/package_saver.py
    M ckan/lib/search/index.py
    M ckan/lib/search/query.py
    M ckan/logic/__init__.py
    M ckan/logic/action/create.py
    M ckan/logic/action/delete.py
    M ckan/logic/action/get.py
    M ckan/logic/action/update.py
    M ckan/logic/auth/create.py
    M ckan/logic/converters.py
    M ckan/logic/schema.py
    M ckan/logic/validators.py
    M ckan/migration/versions/067_turn_extras_to_strings.py
    R ckan/misc.py
    M ckan/model/__init__.py
    M ckan/model/license.py
    M ckan/model/package.py
    M ckan/model/package_relationship.py
    M ckan/model/tag.py
    M ckan/model/tracking.py
    M ckan/new_authz.py
    M ckan/plugins/toolkit.py
    M ckan/public/base/css/main.css
    M ckan/public/base/images/flags.png
    M ckan/public/base/less/footer.less
    M ckan/public/base/less/iehacks.less
    M ckan/public/base/less/layout.less
    M ckan/public/base/less/mixins.less
    M ckan/public/base/less/prose.less
    M ckan/public/base/test/index.html
    M ckan/public/base/test/spec/client.spec.js
    M ckan/public/base/test/spec/modules/autocomplete.spec.js
    M ckan/templates/activity_streams/activity_stream_items.html
    M ckan/templates/development/primer.html
    A ckan/templates/development/snippets/actions.html
    A ckan/templates/development/snippets/context.html
    M ckan/templates/development/snippets/facet.html
    M ckan/templates/development/snippets/media_grid.html
    M ckan/templates/development/snippets/nav.html
    M ckan/templates/development/snippets/page_header.html
    R ckan/templates/development/snippets/toolbar.html
    M ckan/templates/group/about.html
    M ckan/templates/group/activity_stream.html
    M ckan/templates/group/admins.html
    M ckan/templates/group/confirm_delete.html
    M ckan/templates/group/confirm_delete_member.html
    M ckan/templates/group/followers.html
    A ckan/templates/group/history.html
    M ckan/templates/group/index.html
    M ckan/templates/group/member_new.html
    M ckan/templates/group/members.html
    M ckan/templates/group/read.html
    A ckan/templates/group/snippets/history_revisions.html
    A ckan/templates/group/snippets/revisions_table.html
    M ckan/templates/header.html
    M ckan/templates/organization/about.html
    M ckan/templates/organization/activity_stream.html
    M ckan/templates/organization/admins.html
    M ckan/templates/organization/base_form_page.html
    M ckan/templates/organization/bulk_process.html
    M ckan/templates/organization/confirm_delete.html
    M ckan/templates/organization/confirm_delete_member.html
    M ckan/templates/organization/edit.html
    M ckan/templates/organization/index.html
    M ckan/templates/organization/member_new.html
    M ckan/templates/organization/new.html
    M ckan/templates/organization/read.html
    M ckan/templates/package/activity.html
    M ckan/templates/package/activity_stream.html
    M ckan/templates/package/confirm_delete.html
    M ckan/templates/package/confirm_delete_resource.html
    M ckan/templates/package/followers.html
    A ckan/templates/package/history.html
    M ckan/templates/package/read.html
    M ckan/templates/package/read_base.html
    M ckan/templates/package/related_list.html
    M ckan/templates/package/resource_read.html
    M ckan/templates/package/search.html
    M ckan/templates/package/snippets/additional_info.html
    M ckan/templates/package/snippets/data_api_button.html
    A ckan/templates/package/snippets/history_revisions.html
    M ckan/templates/package/snippets/info.html
    M ckan/templates/package/snippets/package_basic_fields.html
    M ckan/templates/package/snippets/package_metadata_fields.html
    M ckan/templates/package/snippets/resource_form.html
    M ckan/templates/package/snippets/resources_list.html
    A ckan/templates/package/snippets/revisions_table.html
    M ckan/templates/package/snippets/search_form.html
    M ckan/templates/related/confirm_delete.html
    M ckan/templates/related/dashboard.html
    A ckan/templates/revision/__init__.py
    A ckan/templates/revision/diff.html
    A ckan/templates/revision/list.html
    A ckan/templates/revision/read.html
    A ckan/templates/revision/read_base.html
    A ckan/templates/revision/snippets/revisions_list.html
    M ckan/templates/snippets/facet_list.html
    M ckan/templates/snippets/license.html
    M ckan/templates/snippets/sort_by.html
    M ckan/templates/tag/index.html
    M ckan/templates/user/activity_stream.html
    M ckan/templates/user/dashboard.html
    M ckan/templates/user/followers.html
    M ckan/templates/user/list.html
    M ckan/templates/user/login.html
    M ckan/templates/user/logout.html
    M ckan/templates/user/new.html
    M ckan/templates/user/perform_reset.html
    M ckan/templates/user/read.html
    M ckan/templates_legacy/package/read_core.html
    M ckan/tests/functional/api/model/test_vocabulary.py
    M ckan/tests/functional/api/test_dashboard.py
    M ckan/tests/functional/test_home.py
    M ckan/tests/functional/test_package.py
    M ckan/tests/functional/test_pagination.py
    M ckan/tests/functional/test_user.py
    M ckan/tests/lib/test_dictization.py
    M ckan/tests/lib/test_solr_package_search.py
    M ckan/tests/logic/test_action.py
    A ckan/tests/logic/test_init.py
    M ckan/tests/logic/test_member.py
    M ckan/tests/misc/test_format_text.py
    M ckan/tests/models/test_package.py
    M ckanext/datastore/bin/set_permissions.sql
    M ckanext/datastore/commands.py
    M ckanext/datastore/db.py
    M ckanext/datastore/plugin.py
    M ckanext/datastore/tests/test_configure.py
    M ckanext/datastore/tests/test_search.py
    A ckanext/example_idatasetform/templates/package/snippets/package_basic_fields.html
    M ckanext/example_idatasetform/templates/package/snippets/package_metadata_fields.html
    M ckanext/reclinepreview/theme/public/preview_recline.js
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.css
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.dataset.js
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.dataset.min.js
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.js
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.min.css
    M ckanext/reclinepreview/theme/public/vendor/recline/recline.min.js
    M doc/_templates/footer.html
    R doc/about.rst
    M doc/authorization.rst
    R doc/commenting.rst
    M doc/conf.py
    M doc/configuration.rst
    R doc/contrib.rst
    A doc/contributing.rst
    M doc/css-coding-standards.rst
    M doc/database-dumps.rst
    M doc/frontend-development.rst
    A doc/images/popular-dataset.png
    A doc/images/popular-resource.png
    A doc/images/sort-datasets-by-popularity.png
    A doc/importing-datasets.rst
    M doc/index.rst
    M doc/install-from-source.rst
    M doc/javascript-coding-standards.rst
    M doc/javascript-module-tutorial.rst
    M doc/legacy-api.rst
    R doc/loading-data.rst
    R doc/organizations_and_groups.rst
    M doc/paster.rst
    M doc/post-installation.rst
    R doc/publisher-profile.rst
    M doc/publishing-datasets.rst
    M doc/resources.rst
    M doc/templating.rst
    M doc/test.rst
    A doc/tracking.rst
    R doc/user-stories-list.rst
    R doc/user-stories.rst
    M test-core.ini

  Log Message:
  -----------
  Merge remote-tracking branch 'upstream/master' into 534

Conflicts:
	doc/configuration.rst


  Commit: a4bffcb23473a6cb88a39af3b5229e8e86c2372c
      https://github.com/okfn/ckan/commit/a4bffcb23473a6cb88a39af3b5229e8e86c2372c
  Author: Vitor Baptista <vitor at vitorbaptista.com>
  Date:   2013-04-25 (Thu, 25 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: ae3ea3bcfdfbc7900c8bc0b82a993c572e9a1942
      https://github.com/okfn/ckan/commit/ae3ea3bcfdfbc7900c8bc0b82a993c572e9a1942
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-26 (Fri, 26 Apr 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/configuration.rst
    M doc/email-notifications.rst
    M doc/filestore.rst
    M doc/i18n.rst
    M doc/solr-setup.rst
    M doc/tracking.rst
    M test-core.ini

  Log Message:
  -----------
  Merge branch '534' of git://github.com/vitorbaptista/ckan into vitorbaptista-534


  Commit: 624ec6fb38d259a729f4697244edc23344a3dfa0
      https://github.com/okfn/ckan/commit/624ec6fb38d259a729f4697244edc23344a3dfa0
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-26 (Fri, 26 Apr 2013)

  Changed paths:
    M ckan/config/deployment.ini_tmpl
    M doc/configuration.rst
    M doc/email-notifications.rst
    M doc/filestore.rst
    M doc/i18n.rst
    M doc/solr-setup.rst
    M doc/tracking.rst
    M test-core.ini

  Log Message:
  -----------
  Merge branch 'vitorbaptista-534' into 534-update-config-options-docs


  Commit: 66859bf98518a5538e72a684e26a43b9b1ef111d
      https://github.com/okfn/ckan/commit/66859bf98518a5538e72a684e26a43b9b1ef111d
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-26 (Fri, 26 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.


  Commit: 9c05c6fbeac0273aafe0c99021a8fbd70201eba9
      https://github.com/okfn/ckan/commit/9c05c6fbeac0273aafe0c99021a8fbd70201eba9
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-26 (Fri, 26 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


  Commit: 01cd2def9e2be7ffd0afb6de8c96c654b7572a7c
      https://github.com/okfn/ckan/commit/01cd2def9e2be7ffd0afb6de8c96c654b7572a7c
  Author: amercader <amercadero at gmail.com>
  Date:   2013-04-26 (Fri, 26 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


Compare: https://github.com/okfn/ckan/compare/f8c122723f8d^...01cd2def9e2b


More information about the ckan-changes mailing list