[ckan-changes] [okfn/ckan] 254fca: Big docs reorganization

GitHub noreply at github.com
Tue Jan 28 16:34:24 UTC 2014

  Branch: refs/heads/docs-reorg
  Home:   https://github.com/okfn/ckan
  Commit: 254fca2d43ccacbe674df2da42aba83897dcdb96
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2014-01-28 (Tue, 28 Jan 2014)

  Changed paths:
    M ckan/logic/__init__.py
    M ckan/plugins/interfaces.py
    R doc/api.rst
    A doc/api/index.rst
    A doc/api/legacy-api.rst
    R doc/appendices/index.rst
    R doc/appendices/solr-multicore.rst
    R doc/apps-ideas.rst
    R doc/authorization.rst
    R doc/background-tasks.rst
    R doc/configuration.rst
    M doc/contents.rst
    M doc/contributing/architecture.rst
    M doc/contributing/documentation.rst
    M doc/contributing/index.rst
    M doc/contributing/release-process.rst
    A doc/contributing/test.rst
    M doc/contributing/upgrading-dependencies.rst
    R doc/data-viewer.rst
    R doc/datastore.rst
    R doc/deployment.rst
    R doc/email-notifications.rst
    M doc/extensions/index.rst
    M doc/extensions/testing-extensions.rst
    M doc/extensions/tutorial.rst
    R doc/features.rst
    R doc/filestore.rst
    R doc/form-integration.rst
    R doc/getting-started.rst
    M doc/index.rst
    R doc/install-from-package.rst
    R doc/install-from-source.rst
    R doc/installing.rst
    R doc/legacy-api.rst
    R doc/linked-data-and-rdf.rst
    A doc/maintaining/apps-ideas.rst
    A doc/maintaining/authorization.rst
    A doc/maintaining/background-tasks.rst
    A doc/maintaining/configuration.rst
    A doc/maintaining/data-viewer.rst
    A doc/maintaining/datastore.rst
    A doc/maintaining/email-notifications.rst
    A doc/maintaining/filestore.rst
    A doc/maintaining/form-integration.rst
    A doc/maintaining/getting-started.rst
    A doc/maintaining/index.rst
    A doc/maintaining/installing/deployment.rst
    A doc/maintaining/installing/index.rst
    A doc/maintaining/installing/install-from-package.rst
    A doc/maintaining/installing/install-from-source.rst
    A doc/maintaining/linked-data-and-rdf.rst
    A doc/maintaining/multilingual.rst
    A doc/maintaining/paster.rst
    A doc/maintaining/solr-multicore.rst
    A doc/maintaining/stats.rst
    A doc/maintaining/tag-vocabularies.rst
    A doc/maintaining/tracking.rst
    A doc/maintaining/upgrading/index.rst
    A doc/maintaining/upgrading/upgrade-package-ckan-1-to-2.rst
    A doc/maintaining/upgrading/upgrade-package-to-minor-release.rst
    A doc/maintaining/upgrading/upgrade-package-to-patch-release.rst
    A doc/maintaining/upgrading/upgrade-source.rst
    R doc/multilingual.rst
    R doc/paster.rst
    R doc/stats.rst
    M doc/sysadmin-guide.rst
    R doc/tag-vocabularies.rst
    R doc/test.rst
    M doc/theming/index.rst
    M doc/theming/templates.rst
    R doc/tracking.rst
    R doc/upgrade-package-ckan-1-to-2.rst
    R doc/upgrade-package-to-minor-release.rst
    R doc/upgrade-package-to-patch-release.rst
    R doc/upgrade-source.rst
    R doc/upgrading.rst
    M doc/user-guide.rst

  Log Message:
  Big docs reorganization

This is not as big a change as it looks like, because it's taking the way the
docs were already organized by audience and making it explicit by creating
top-level dirs for each audience and moving all the docs into them.
Also cleans up a couple of loose ends where particular files didn't fit into
the organization-based scheme, fit them in. It then has to touch a lot of files
in doc/ to update Sphinx cross-references.

Create 8 top-level directories, one for each different audience:
User guide, sysadmin guide, maintainer's guide, API guide, extending guide,
theming guide, contributing guide and changelog.
(User guide, sysadmin guide and changelog are actually just files, not
directories, because they only need one file each.)

- New overview on docs front page explains the high-level structure

- Added a section to the documentation guidelines explaining the new structure

- Lots of feature pages moved into new maintaining/ dir

- Configuration.rst moved into maintaining/

- getting-started.rst moved into maintaining/

- Move Solr multicore appendix page into maintaining/,
  remove the appendix section itself as no longer needed

- Remove the "Features" index page, no longer needed as the pages just go into
  the "Maintainer's guide" now

- Create doc/maintaining/installing/ subdir and move the installing and
  deployment docs into it

- Create doc/maintaining/upgrading/ subdir and move the upgrading docs into

- Move api.rst and legacy-api.rst into new api/ dir

- Move test.rst into contributing/

- Fix Sphinx references all over the place to point to the new file locations

More information about the ckan-changes mailing list