http://localhost/ticket/1192 <p> As part of the general documentation overhaul (<a class="closed ticket" href="http://localhost/ticket/1142" title="enhancement: [super] Major Overhaul and Extension of CKAN Documentation (closed: fixed)">ticket:1142</a>) we (APS and RGRP) want to convert the current Sphinx docs into: </p> <ul><li>An Admin Manual which is task-based and aims to cover everything a developer would need to know to set up and customize a CKAN install. </li><li>A Reference Manual which is the primary source of reference for CKAN software - this includes API docs. </li></ul><p> The current chapters of the Sphinx docs should be moved as follows: </p> <ul><li>index.rst - copy some stuff from README.txt, keep short </li><li>README.txt - split out installation - stop symlinking in, keep separate, write new intro in index.rst </li><li>[NEW] install.rst - new file on installation </li><li>[NEW] theming.rst - move over from wiki </li><li>api - will stay (gradually move tutorials/getting started to wiki.ckan.net user guide) </li><li>i18n.rst: internationlization. say we have x langauges. just set lang config option. if your lang not there yet see wiki page for how to prepare a translation file </li><li>design.rst - REMOVE (can copy some over if you can be bothered to <a class="ext-link" href="http://wiki.ckan.net/Vision"><span class="icon">​</span>http://wiki.ckan.net/Vision</a> (all philosophical stuff should go!)) </li><li>loaders.rst: move to wiki.ckan.net/Using_Loaders </li><li>feeds.rst: move to User Manual (CKAN_Feeds or just Feeds) </li><li>importer.rst: remove (don't even copy) </li><li>forms.rst: remove (ping david read and ckan-dev asking for replacement documentation -- do we need this in core ckan -- do we want pure js ...?). Suggest we start with (stub out) <a class="ext-link" href="http://wiki.ckan.net/Customizing_Forms"><span class="icon">​</span>http://wiki.ckan.net/Customizing_Forms</a> </li><li>forms-integration.rst: remove </li><li>model.rst: leave but move to reference (only for core devs) </li><li>load-testing.rst -&gt; move to <a class="ext-link" href="http://wiki.ckan.net/Load_Testing"><span class="icon">​</span>http://wiki.ckan.net/Load_Testing</a> </li><li>distributed.rst -&gt; remove </li><li>admin.html should consolidate with authorization.html (some of authorization.html is probably in ref section but howto in main manual) &lt;-- high priority </li><li>deb.html -&gt; go into reference (query james gardner on list about moving this to wiki?) </li></ul> en-us http://assets.okfn.org/p/ckan/img/ckan_logo_shortname.png http://localhost/ticket/1192 Trac 0.12.3 dread Fri, 17 Jun 2011 19:07:32 GMT http://localhost/ticket/1192#comment:1 http://localhost/ticket/1192#comment:1 <p> I really think forms are a key asset of CKAN, and keeping the docs about customising and integrating them is important - i.e. forms.rst and forms-integration.rst. There are ideas being suggested for replacing bits of front-end, but forms hard to do, and David's new system is a significant offering on top of the CKAN back-end, so it seems crazy to me to abandon it. </p> <p> forms.rst has been updated by David Raznick in the release_v1.4.1 branch. </p> <p> i18n.rst - include here the creation of the pot file, deploying a translation, transifex admin </p> <p> load-testing.rst - I think performance should be mentioned in the glossy guide (some sort of basic metrics of speed profile, to return web pages, run searches and API operations, for 100 or 1000 packages, on a given spec machine) and have it based on a report showing how we measured it. The report would look a bit like this file, and it might do as a stub, but it seems pretty lacking. </p> <p> distributed.rst - agreed, remove. </p> <p> design.rst - agreed, delete. </p> <p> loaders.rst / loader_scripts.rst - yes move to wiki </p> <p> feeds.rst - this should be split into a tutorial for the wiki and the reference page left in sphinx </p> <p> importer.rst - this should be moved to ckanext-importer/doc </p> <p> admin.html - this has already gone in 1.4.1 </p> <p> authorization.rst - This is a bit jumbled. We're talking about changes to the code, so maybe not worth working hard to make this good, so I suggest leaving it, but delete the boring section "Requirements and Use Cases". </p> <p> deb.rst - this is an administrator task, so should stay why move this to the wiki? </p> <p> buildbot.rst - ok to stay here? </p> <p> vm.rst - I assume there's no problem with this </p> Ticket thejimmyg Fri, 08 Jul 2011 14:31:08 GMT http://localhost/ticket/1192#comment:2 http://localhost/ticket/1192#comment:2 <ul> <li><strong>milestone</strong> set to <em>ckan-backlog</em> </li> </ul> <p> This is now a child ticket of <a class="closed ticket" href="http://localhost/ticket/1142" title="enhancement: [super] Major Overhaul and Extension of CKAN Documentation (closed: fixed)">#1142</a> </p> Ticket thejimmyg Wed, 20 Jul 2011 15:14:23 GMT http://localhost/ticket/1192#comment:3 http://localhost/ticket/1192#comment:3 <ul> <li><strong>milestone</strong> changed from <em>ckan-backlog</em> to <em>ckan-current-sprint</em> </li> </ul> Ticket rgrp Mon, 01 Aug 2011 09:37:42 GMT http://localhost/ticket/1192#comment:4 http://localhost/ticket/1192#comment:4 <ul> <li><strong>status</strong> changed from <em>new</em> to <em>closed</em> </li> <li><strong>resolution</strong> set to <em>fixed</em> </li> </ul> <p> Marking this as closed as Anna has completed and this is now deployed at <a class="ext-link" href="http://docs.ckan.org/"><span class="icon">​</span>http://docs.ckan.org/</a>. </p> Ticket