[ckan-dev] Remaining documentation issues for CKAN 2.0

Wed Apr 17 08:33:40 UTC 2013

On 16 April 2013 21:19, Sean Hammond <sean.hammond at okfn.org> wrote:

> I've gone over the remaining docs issues on github.
>
> I moved three of the issues into 2.1, we can forget about these for now:
>
>
> https://github.com/okfn/ckan/issues?labels=docs&milestone=3&page=1&state=open
>
> There are 12 remaining high priority docs in the CKAN 2.0 milestone,
> these are the ones we need to get done:
>
>
> https://github.com/okfn/ckan/issues?labels=docs%2Cpriority.high&milestone=1&page=1&state=open
>
> They're all assigned to people.
>
> There are 9 non-high-priority issues still in the 2.0 milestone:
>
> Update writing extensions docs
> Update Release Process docs
> Move 'Contrib & Tools' page from docs to github wiki
> Remove 'Common Error Messages' docs
> Update 'Load Datasets' docs
> Update Publishing Datasets docs
> Update Linked Data & RDF docs
> Remove Comments and Commenting docs
> Improve the apps & ideas docs
>
> Some of these will probably get done as people have already started on
> them, others won't.
>
> Once we've all written as many docs as we have time to, I'll use
> whatever remaining time I can get to take an overall look and rearrange
> things, and also delete any out-of-date pages that we haven't had time
> to update.
>
> If I can get the overall structure of the docs down to something much
> simpler, then I hope that in future it'll be easier to break down docs
> into one-person tasks like "document feature X" or "update docs for
> feature X", then we can iteratively improve the docs in individual
> chunks that can be bitten off by individual devs as and when they can,
> without so much confusion about "should this be removed?", "should this
> be rearranged?", "does this need to be updated?"
>
>
Yes this is part one of the docs refresh we will need to do another round
in 2.1
Also we need to get better on updating docs as we go not leaving them till
later
So we get feature + tests + docs = job done

> However, this sort of restructuring will need some thought and probably
> at least a couple of days' work
>
> _______________________________________________
> ckan-dev mailing list
> ckan-dev at lists.okfn.org
> http://lists.okfn.org/mailman/listinfo/ckan-dev
> Unsubscribe: http://lists.okfn.org/mailman/options/ckan-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.okfn.org/pipermail/ckan-dev/attachments/20130417/caf9d837/attachment-0001.html>