[ckan-changes] [okfn/ckan] ce3e42: Various FileStore docs fixes

Mon Dec 9 13:49:18 UTC 2013

  Branch: refs/heads/fix-filestore-docs
  Home:   https://github.com/okfn/ckan
  Commit: ce3e42b9cb867d9f04163dd3834b0b7e113c4d09
      https://github.com/okfn/ckan/commit/ce3e42b9cb867d9f04163dd3834b0b7e113c4d09
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-12-09 (Mon, 09 Dec 2013)

  Changed paths:
    M doc/filestore.rst

  Log Message:
  -----------
  Various FileStore docs fixes

Correct storage_dir to storage_path.

Correct case in titles (see doc guidelines).

Fix Sphinx warnings - title underlines too long.

When mentioning config settings, cross-reference them.

When mentioning action functions, cross-reference them.

api = API

json = JSON

python = Python

Dedent parsed literals - the rst was formatted wrong so that it was outputting
literals inside blockquotes.

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

  Changed paths:
    M doc/filestore.rst

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

If you're going to mention another section in the docs, cross-reference
it properly. This way if that section gets moved or deleted, a Sphinx
error will remind you to update the cross-reference (or Sphinx will do
it automatically). Also users get a nice hyperlink.

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

  Changed paths:
    M doc/filestore.rst

  Log Message:
  -----------
  General edit of new FileStore docs

Edit text for clarity, simplicity.

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

  Changed paths:
    M doc/filestore.rst

  Log Message:
  -----------
  Change DataStore ref in FileStore docs to seealso

It'll be good if we can use this style (a Sphinx .. seealso::, near the
top of the page) whenever we want to say "also see this page" in the
docs. That'll make it a lot more predictable and easier for users to
find, when one feature is connected to another.

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

  Changed paths:
    M doc/filestore.rst

  Log Message:
  -----------
  Spellcheck new FileStore docs

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

  Changed paths:
    M doc/documentation-guidelines.rst

  Log Message:
  -----------
  Add some details to the documentation guidelines

Compare: https://github.com/okfn/ckan/compare/ce3e42b9cb86^...07449ae59acf