[ckan-changes] [okfn/ckan] 8c0e63: Reorganize the contributing docs

GitHub noreply at github.com
Tue Dec 17 10:45:50 UTC 2013


  Branch: refs/heads/master
  Home:   https://github.com/okfn/ckan
  Commit: 8c0e6341e45ac40c488b5cecb3807073091a5447
      https://github.com/okfn/ckan/commit/8c0e6341e45ac40c488b5cecb3807073091a5447
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-11-15 (Fri, 15 Nov 2013)

  Changed paths:
    M CONTRIBUTING.rst
    M ckan/plugins/interfaces.py
    R doc/ckan-coding-standards.rst
    M doc/configuration.rst
    R doc/contributing.rst
    A doc/contributing/coding-standards/ckan-code-architecture.rst
    A doc/contributing/coding-standards/css-coding-standards.rst
    A doc/contributing/coding-standards/database-migrations.rst
    A doc/contributing/coding-standards/html-coding-standards.rst
    A doc/contributing/coding-standards/index.rst
    A doc/contributing/coding-standards/javascript-coding-standards.rst
    A doc/contributing/coding-standards/python-coding-standards.rst
    A doc/contributing/coding-standards/testing-coding-standards.rst
    A doc/contributing/coding-standards/upgrading-dependencies.rst
    A doc/contributing/documentation-guidelines.rst
    A doc/contributing/frontend/index.rst
    A doc/contributing/frontend/javascript-module-tutorial.rst
    A doc/contributing/frontend/resources.rst
    A doc/contributing/frontend/template-blocks.rst
    A doc/contributing/frontend/template-tutorial.rst
    A doc/contributing/frontend/templating.rst
    A doc/contributing/i18n.rst
    A doc/contributing/index.rst
    A doc/contributing/issues.rst
    A doc/contributing/pull-requests.rst
    R doc/css-coding-standards.rst
    R doc/documentation-guidelines.rst
    M doc/extensions/best-practices.rst
    R doc/frontend-development.rst
    R doc/html-coding-standards.rst
    R doc/i18n.rst
    M doc/index.rst
    R doc/javascript-coding-standards.rst
    R doc/javascript-module-tutorial.rst
    R doc/migration.rst
    M doc/multilingual.rst
    R doc/python-coding-standards.rst
    R doc/resources.rst
    R doc/template-blocks.rst
    R doc/template-tutorial.rst
    R doc/templating.rst
    R doc/testing-coding-standards.rst
    R doc/upgrading-dependencies.rst

  Log Message:
  -----------
  Reorganize the contributing docs


  Commit: 8af7420dcfc5037836e9b0f127a9c257428c6d7a
      https://github.com/okfn/ckan/commit/8af7420dcfc5037836e9b0f127a9c257428c6d7a
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-16 (Mon, 16 Dec 2013)

  Changed paths:
    M CHANGELOG.rst
    M MANIFEST.in
    M bin/travis-install-dependencies
    M bin/travis-run-tests
    M ckan/ckan_nose_plugin.py
    M ckan/config/deployment.ini_tmpl
    M ckan/config/environment.py
    M ckan/config/routing.py
    R ckan/config/solr/CHANGELOG.txt
    M ckan/config/solr/README.txt
    M ckan/config/solr/schema-1.2.xml
    M ckan/config/solr/schema-1.3.xml
    M ckan/config/solr/schema-1.4.xml
    M ckan/config/solr/schema-2.0.xml
    A ckan/config/solr/schema.xml
    M ckan/controllers/api.py
    M ckan/controllers/group.py
    M ckan/controllers/package.py
    M ckan/controllers/user.py
    M ckan/lib/accept.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/helpers.py
    M ckan/lib/plugins.py
    M ckan/lib/uploader.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/auth/get.py
    M ckan/logic/auth/update.py
    M ckan/logic/converters.py
    M ckan/logic/schema.py
    M ckan/logic/validators.py
    M ckan/model/group.py
    M ckan/new_authz.py
    M ckan/new_tests/factories.py
    M ckan/new_tests/helpers.py
    A ckan/new_tests/logic/action/test_get.py
    M ckan/new_tests/logic/action/test_update.py
    M ckan/public/base/css/fuchsia.css
    M ckan/public/base/css/green.css
    M ckan/public/base/css/main.css
    M ckan/public/base/css/maroon.css
    M ckan/public/base/css/red.css
    M ckan/public/base/javascript/main.js
    M ckan/public/base/javascript/modules/image-upload.js
    A ckan/public/base/javascript/modules/resource-reorder.js
    M ckan/public/base/javascript/modules/slug-preview.js
    M ckan/public/base/javascript/resource.config
    M ckan/public/base/less/dataset.less
    M ckan/public/base/less/forms.less
    M ckan/public/base/less/layout.less
    M ckan/public/base/less/search.less
    A ckan/public/base/vendor/jquery.ui.core.js
    A ckan/public/base/vendor/jquery.ui.mouse.js
    A ckan/public/base/vendor/jquery.ui.sortable.js
    M ckan/public/base/vendor/jquery.ui.widget.js
    M ckan/public/base/vendor/resource.config
    M ckan/templates/admin/config.html
    M ckan/templates/base.html
    M ckan/templates/group/about.html
    M ckan/templates/group/activity_stream.html
    M ckan/templates/group/edit.html
    M ckan/templates/group/edit_base.html
    M ckan/templates/group/index.html
    M ckan/templates/group/member_new.html
    M ckan/templates/group/members.html
    M ckan/templates/group/new.html
    M ckan/templates/group/read.html
    M ckan/templates/group/read_base.html
    M ckan/templates/group/snippets/group_form.html
    M ckan/templates/group/snippets/group_item.html
    M ckan/templates/header.html
    M ckan/templates/macros/form.html
    M ckan/templates/organization/about.html
    M ckan/templates/organization/activity_stream.html
    M ckan/templates/organization/edit.html
    M ckan/templates/organization/edit_base.html
    M ckan/templates/organization/index.html
    M ckan/templates/organization/member_new.html
    M ckan/templates/organization/members.html
    M ckan/templates/organization/read.html
    M ckan/templates/organization/read_base.html
    M ckan/templates/organization/snippets/organization_form.html
    M ckan/templates/package/activity.html
    R ckan/templates/package/activity_stream.html
    M ckan/templates/package/base.html
    M ckan/templates/package/base_form_page.html
    A ckan/templates/package/group_list.html
    M ckan/templates/package/new.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_data.html
    M ckan/templates/package/resource_edit_base.html
    M ckan/templates/package/resource_read.html
    M ckan/templates/package/resources.html
    M ckan/templates/package/search.html
    M ckan/templates/package/snippets/package_basic_fields.html
    M ckan/templates/package/snippets/package_form.html
    M ckan/templates/package/snippets/package_metadata_fields.html
    M ckan/templates/package/snippets/resource_form.html
    M ckan/templates/package/snippets/resource_item.html
    M ckan/templates/snippets/organization.html
    M ckan/templates/snippets/package_list.html
    M ckan/templates/snippets/search_form.html
    M ckan/templates/snippets/search_result_text.html
    M ckan/templates/user/activity_stream.html
    M ckan/templates/user/dashboard.html
    M ckan/templates/user/edit.html
    M ckan/templates/user/edit_base.html
    M ckan/templates/user/edit_user_form.html
    M ckan/templates/user/read.html
    M ckan/templates/user/read_base.html
    R ckan/templates/user/snippets/back_to_user_action.html
    M ckan/templates/user/snippets/login_form.html
    M ckan/tests/functional/api/test_activity.py
    M ckan/tests/functional/test_group.py
    M ckan/tests/functional/test_package.py
    M ckan/tests/lib/test_accept.py
    M ckan/tests/lib/test_dictization.py
    M ckan/tests/lib/test_solr_schema_version.py
    M ckan/tests/logic/test_action.py
    M ckan/tests/logic/test_auth.py
    M ckan/tests/logic/test_member.py
    M ckan/tests/models/test_group.py
    M ckan/tests/test_coding_standards.py
    M ckanext/datapusher/helpers.py
    M ckanext/datapusher/logic/action.py
    M ckanext/datapusher/plugin.py
    M ckanext/datapusher/tests/test.py
    M ckanext/datastore/db.py
    M ckanext/datastore/logic/action.py
    M ckanext/datastore/logic/auth.py
    M ckanext/datastore/plugin.py
    M doc/api.rst
    A doc/appendices/index.rst
    A doc/appendices/solr-multicore.rst
    M doc/background-tasks.rst
    M doc/conf.py
    M doc/configuration.rst
    A doc/contents.rst
    M doc/contributing/coding-standards/testing-coding-standards.rst
    M doc/contributing/documentation-guidelines.rst
    M doc/data-viewer.rst
    M doc/datastore.rst
    M doc/deployment.rst
    M doc/email-notifications.rst
    M doc/filestore.rst
    M doc/getting-started.rst
    A doc/images/add_dataset_1.jpg
    A doc/images/add_dataset_2.jpg
    A doc/images/add_dataset_3.jpg
    R doc/images/admin-page.png
    A doc/images/create_organization.jpg
    A doc/images/customize_look_and_feel.jpg
    A doc/images/edit_dataset.jpg
    A doc/images/exploring_datasets.jpg
    A doc/images/manage_news_feed.jpg
    A doc/images/manage_organization.jpg
    A doc/images/manage_user_profile.jpg
    A doc/images/manage_users.jpg
    A doc/images/move_dataset_between_organizations.jpg
    A doc/images/register_account.jpg
    A doc/images/search_the_site.jpg
    M doc/index.rst
    M doc/install-from-package.rst
    M doc/install-from-source.rst
    M doc/release-process.rst
    R doc/solr-setup.rst
    A doc/sysadmin-guide.rst
    M doc/test.rst
    M doc/upgrade-package-to-minor-release.rst
    M doc/upgrade-source.rst
    A doc/user-guide.rst
    M requirements.txt

  Log Message:
  -----------
  Merge branch 'master' of github.com:okfn/ckan into contributing-docs-reorg

Conflicts:
	CONTRIBUTING.rst
	doc/contributing/coding-standards/css-coding-standards.rst
	doc/index.rst


  Commit: b3dff01892fd6e0fc8add0b5ffc53f9cb3a677a5
      https://github.com/okfn/ckan/commit/b3dff01892fd6e0fc8add0b5ffc53f9cb3a677a5
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-16 (Mon, 16 Dec 2013)

  Changed paths:
    M doc/contributing/pull-requests.rst

  Log Message:
  -----------
  Replace example good commit message in docs

The example was not actually a very good example, replace it with a
better one from recent git logs.


  Commit: 84fc1b8bebd81f1712e03849edaf4440e6ad7d76
      https://github.com/okfn/ckan/commit/84fc1b8bebd81f1712e03849edaf4440e6ad7d76
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-16 (Mon, 16 Dec 2013)

  Changed paths:
    M doc/conf.py
    A doc/contributing/architecture.rst
    R doc/contributing/coding-standards/ckan-code-architecture.rst
    R doc/contributing/coding-standards/css-coding-standards.rst
    R doc/contributing/coding-standards/database-migrations.rst
    R doc/contributing/coding-standards/html-coding-standards.rst
    R doc/contributing/coding-standards/index.rst
    R doc/contributing/coding-standards/javascript-coding-standards.rst
    R doc/contributing/coding-standards/python-coding-standards.rst
    R doc/contributing/coding-standards/testing-coding-standards.rst
    R doc/contributing/coding-standards/upgrading-dependencies.rst
    A doc/contributing/commit-messages.rst
    A doc/contributing/css.rst
    A doc/contributing/database-migrations.rst
    R doc/contributing/documentation-guidelines.rst
    A doc/contributing/documentation.rst
    M doc/contributing/frontend/index.rst
    A doc/contributing/html.rst
    M doc/contributing/i18n.rst
    M doc/contributing/index.rst
    M doc/contributing/issues.rst
    A doc/contributing/javascript.rst
    M doc/contributing/pull-requests.rst
    A doc/contributing/python.rst
    A doc/contributing/reviewing.rst
    A doc/contributing/testing.rst
    A doc/contributing/upgrading-dependencies.rst
    M doc/extensions/best-practices.rst

  Log Message:
  -----------
  Another contributing docs reorganization

Redorder it all into a single docs/contributing/ subdirectory with one table
of contents and no sub-sub-directories (except for the frontend guidelines one,
which still needs sorting out). This makes it much easier to see what's there
(one main table of contents for all of contributing) and navigate.

Add _CKAN issue tracker hyperlink target to conf.py.

Move commit messages guidelines to their own page.

Move reviewing a pull request guidelines to their own page.

Fix title style of various titles.

A few other small changes


  Commit: fd53401864661b479c1e4d041e935ee1c240048b
      https://github.com/okfn/ckan/commit/fd53401864661b479c1e4d041e935ee1c240048b
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-16 (Mon, 16 Dec 2013)

  Changed paths:
    M doc/contributing/documentation.rst

  Log Message:
  -----------
  Fix a Sphinx cross-reference


  Commit: 1522c4c3c67a052dc1e1d0a0ada0a86314224599
      https://github.com/okfn/ckan/commit/1522c4c3c67a052dc1e1d0a0ada0a86314224599
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-16 (Mon, 16 Dec 2013)

  Changed paths:
    M doc/contributing/documentation.rst

  Log Message:
  -----------
  Add a couple of notes to the documentation guidelines


  Commit: 5b30653d0376f3c6c5043fbdb2d151a8c7c170b9
      https://github.com/okfn/ckan/commit/5b30653d0376f3c6c5043fbdb2d151a8c7c170b9
  Author: Nigel Babu <nigelbabu at gmail.com>
  Date:   2013-12-17 (Tue, 17 Dec 2013)

  Changed paths:
    M CONTRIBUTING.rst
    R doc/ckan-coding-standards.rst
    M doc/conf.py
    M doc/configuration.rst
    M doc/contents.rst
    R doc/contributing.rst
    A doc/contributing/architecture.rst
    A doc/contributing/commit-messages.rst
    A doc/contributing/css.rst
    A doc/contributing/database-migrations.rst
    A doc/contributing/documentation.rst
    A doc/contributing/frontend/index.rst
    A doc/contributing/frontend/javascript-module-tutorial.rst
    A doc/contributing/frontend/resources.rst
    A doc/contributing/frontend/template-blocks.rst
    A doc/contributing/frontend/template-tutorial.rst
    A doc/contributing/frontend/templating.rst
    A doc/contributing/html.rst
    A doc/contributing/i18n.rst
    A doc/contributing/index.rst
    A doc/contributing/issues.rst
    A doc/contributing/javascript.rst
    A doc/contributing/pull-requests.rst
    A doc/contributing/python.rst
    A doc/contributing/reviewing.rst
    A doc/contributing/testing.rst
    A doc/contributing/upgrading-dependencies.rst
    R doc/css-coding-standards.rst
    R doc/documentation-guidelines.rst
    M doc/extensions/best-practices.rst
    R doc/frontend-development.rst
    R doc/html-coding-standards.rst
    R doc/i18n.rst
    M doc/index.rst
    R doc/javascript-coding-standards.rst
    R doc/javascript-module-tutorial.rst
    R doc/migration.rst
    M doc/multilingual.rst
    R doc/python-coding-standards.rst
    R doc/resources.rst
    R doc/template-blocks.rst
    R doc/template-tutorial.rst
    R doc/templating.rst
    R doc/testing-coding-standards.rst
    R doc/upgrading-dependencies.rst

  Log Message:
  -----------
  Merge pull request #1324 from okfn/contributing-docs-reorg

Reorganize the contributing docs


Compare: https://github.com/okfn/ckan/compare/d6ab05be812a...5b30653d0376


More information about the ckan-changes mailing list