[ckan-changes] [okfn/ckan] 172563: [#769] Huge docs reorganization

Wed May 22 15:11:56 UTC 2013

  Branch: refs/heads/769-docs-reorg
  Home:   https://github.com/okfn/ckan
  Commit: 172563b084c79aba3ddf96549dc572b11216b7dd
      https://github.com/okfn/ckan/commit/172563b084c79aba3ddf96549dc572b11216b7dd
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-22 (Wed, 22 May 2013)

  Changed paths:
    A CHANGELOG.rst
    R CHANGELOG.txt
    M CONTRIBUTING.rst
    M ckan/logic/action/create.py
    M ckan/logic/action/delete.py
    M ckan/logic/action/get.py
    M ckan/logic/action/update.py
    R doc/CHANGELOG.rst
    M doc/api.rst
    R doc/architecture.rst
    M doc/background-tasks.rst
    A doc/changelog.rst
    A doc/ckan-coding-standards.rst
    R doc/ckan.logic.action.create.rst
    R doc/ckan.logic.action.delete.rst
    R doc/ckan.logic.action.get.rst
    R doc/ckan.logic.action.update.rst
    R doc/common-error-messages.rst
    M doc/conf.py
    M doc/configuration.rst
    R doc/database-dumps.rst
    R doc/datastore-api.rst
    R doc/datastore-setup.rst
    M doc/datastore.rst
    M doc/deployment.rst
    M doc/email-notifications.rst
    R doc/extensions.rst
    A doc/features.rst
    R doc/filestore-api.rst
    M doc/filestore.rst
    M doc/frontend-development.rst
    R doc/frontend-testing.rst
    A doc/getting-started.rst
    A doc/images/admin-page.png
    R doc/importing-datasets.rst
    M doc/index.rst
    M doc/install-from-package.rst
    M doc/install-from-source.rst
    A doc/installing.rst
    M doc/multilingual.rst
    M doc/paster.rst
    R doc/post-installation.rst
    R doc/publishing-datasets.rst
    M doc/release-cycle.rst
    M doc/release-process.rst
    M doc/tag-vocabularies.rst
    M doc/test.rst
    M doc/theming.rst
    A doc/upgrading-a-package-install.rst
    A doc/upgrading-a-source-install.rst
    A doc/writing-extensions.rst

  Log Message:
  -----------
  [#769] Huge docs reorganization

The main changes are:

- Completely redesigned the main table of contents. This is intended to
  be a much simpler, clearer, more linear structure, both for readers to
  find their way and for developers to know where to add new docs.

- New "Installing" page that links to all the pages about
  installing/deploying/upgrading package installs and source installs.
  This is needed mainly so we have somewhere to explain the choice
  between package and source install.

- Move "Upgrading a Package Install to CKAN 2.0" and "Upgrading a Source
  Install" onto their own pages. These should be merged into a single
  "Upgrading CKAN" page in the future.

- Rename the "Deployment" page to "Deploying a Source Install", you
  don't need to do it for package installs.

- Renamed the "Post-Installation Setup" page to "Getting Started", moved some
  stuff from the "Theming" page to here, edited the page, adding a
  screenshot. This page could probably be improved a lot.

- Rename the "CKAN Paster Commands" page to "Command Line Interface" and
  rewrite it. It should be much clearer about how to use and
  troubleshoot paster commands now.

  Also move the paster commands reference into the same page, so all CLI
  docs are on one page.

  Moved this page much higher up in the table of contents so people
  should find out shortly after doing either a package or source
  install, how to run paster commands.

- Deleted the "Database Dumps" page, this was double-documented in the Paster
  Commands Reference, I merged the differences in.

- Deleted the "Extensions" page. We now just have a "Features" section
  that lists every core feature and core extension (each has its own
  page).

  Users don't care whether something is a core feature or a core
  extension, they just want to know what it does and how to use it.

  Writing extensions is still covered on the "Writing Extensions" page.

- Moved all the FileStore stuff (overview, setup, API) onto one
  FileStore page.

- Moved all the datastore docs: overview, setup, api onto one page.
  Moved datastore API reference docs from Action API page into datastore
  page.

- Delete the "Importing Datasets" page. Move the API example from this page onto
  the API page.

- Added module-level docstrings to the files in ckan/logic/action/*.py,
  for the benefit of the action API reference docs

- Put the Action API reference docs back onto the same page with the API
  overview docs, instead of splitting it all across 5 pages.

- Rewrote the CONTRIBUTING file, it now contains everything: reporting
  issues, translating, all the different coding standards, commit
  messages, frontend development guidelines, writing documentation,
  making and merging pull requests ... all in one place.

- Renamed CKAN Code Architecture to CKAN Coding Standards

- Renamed the "Testing for Developers" page to "Testing CKAN"

- Moved the "Frontend Testing" page into the "Testing CKAN" page, so now
  all the docs about testing are on one page.

- Deleted the "Common Error Messages" page. I moved some of the error messages
  to other places, the rest of them looked no longer relevant.

- Deleted the "Publishing Datasets" page. Just deleted it.

- Lots of editing all over the place, but much more is needed.

  Commit: ace5c30d6505bd99b8bb62bd2d3b57f1478db31c
      https://github.com/okfn/ckan/commit/ace5c30d6505bd99b8bb62bd2d3b57f1478db31c
  Author: Sean Hammond <seanhammond at lavabit.com>
  Date:   2013-05-22 (Wed, 22 May 2013)

  Changed paths:
    M doc/conf.py

  Log Message:
  -----------
  [#769] Change docs sidebar contents

- Show Next Page and Prev Page links in sidebar

- Don't show the current page's table of contents in the sidebar,
  this is already contained (and expanded) within the global table of contents
  that's already shown in the sidebar

- Don't show the table of contents in the sidebar, on the table of contents
  page!

Compare: https://github.com/okfn/ckan/compare/172563b084c7^...ace5c30d6505