[super] User guide with integrated help in the WUI

[rgrp]

Provide help to users in the WUI, with this linking to a detailed user guide.

• User guide (suggest at help.thedatahub.org (or possibly help.ckan.org)
• Snippets in the WUI with links to full user guide.
  • Provide helper methods for creating these links with config options for setting path to user guide so that the link location can vary on install by install basis
• General info about publishing/working with/etc data (where we don't duplicate elsewhere)

Est: (?) 5-10d

Topics

See ​http://ckan.okfnpad.org/datahub-help

• Step-by-step for adding a dataset including tips
  • Reuse: ​http://datapatterns.org/datahub.html
  • Quick overview of relevant parts of domain model (dataset and resource)
• API (perhaps link to main docs)
• Command line interface and dpm
• Using groups

Why do this

We already have wiki.ckan.org and docs.ckan.org. Why do this?

Answer for docs:

• This is administrative guide and focused on general CKAN software.
• Hard to provide completely generic help.
• Integratable with the DataHub? site

Answer for wiki:

• No spam
• General feeling that wikis are a little bit loose and untidy. We want this to be smart, clean and useful.
• Integratable with the DataHub?

[rgrp]

Booted: ​https://github.com/okfn/help.thedatahub.org

[rgrp]

Update (for reasons to do with CNAMES) repo is now:

​https://github.com/okfn/datahub-help

Pages are now deployed at (no theming yet!):

​http://help.thedatahub.org/

[dread]

Nice tutorial - that is one nice use case for the Data Hub we want to push. And good to be able to have context help in CKAN, with configurable URLs. I'm just wondering why boot another Sphinx, on top of our existing wiki.ckan.org, ckan.org & ReadTheDocs? solution? Why has it changed from a couple of months ago when we redesigned the docs with Anna and we all decided that User Docs should live in the wiki.

[rgrp]

Closing as wontfix atm since think this will either go to main manual or won't be done here. (Also did quite a lot of work).