Ticket #1400 (closed enhancement: fixed)
Document Archiver Extension
| Reported by: | rgrp | Owned by: | johnglover |
|---|---|---|---|
| Priority: | major | Milestone: | ckan-sprint-2012-03-05 |
| Component: | ckan | Keywords: | 0.5d |
| Cc: | Repository: | ckan | |
| Theme: | none |
Description
- Create page on http://wiki.ckan.org/ about setting up a queue (this will merge into core docs when this is stable) - having a queue will now become a generic requirement for a bunch of extensions
- README with install instructions in ckanext-archiver
- Create an entry in http://wiki.ckan.org/Extensions
- Write a blog post
Change History
comment:1 Changed 2 years ago by rgrp
- Owner changed from kindly to johnglover
- Status changed from new to assigned
- Milestone changed from ckan-v1.6 to current-ckan-sprint-2012-02-20
comment:2 Changed 2 years ago by johnglover
I haven't written any docs for this. I'm also not sure what the status is, Ross was doing some work on it recently so he is probably the man to ask.
comment:3 Changed 2 years ago by rgrp
- Priority changed from awaiting triage to major
@johnglover: I don't think Ross has done much here and he's obviously occupied with DGU at ;-) As you worked on this earlier would be able to look at this and a) check what docs there are b) add to them as necessary :-)
comment:4 Changed 2 years ago by johnglover
- Keywords 0.5d added
- Milestone changed from current-ckan-sprint-2012-02-20 to ckan-sprint-2012-03-05
Will document and update wiki this sprint then ping Mark about a blog post.
comment:5 Changed 2 years ago by johnglover
- Status changed from assigned to closed
- Resolution set to fixed
Async task docs are at: http://wiki.ckan.org/Writing_asynchronous_tasks Archiver readme at: http://github.com/okfn/ckanext-archiver
Emailing Mark RE blog post.
comment:6 Changed 2 years ago by rgrp
Great to see this is done. I do have one question: why did we put this on the wiki rather than in the proper CKAN docs? In general, I think it would be better to use the wiki less and our proper docs more ...
comment:7 Changed 2 years ago by johnglover
I thought that we had some sort of consensus that the official docs were aimed more at system admins and people using the CKAN WUI/API, with the wiki aimed more at developers? It would be easy to move of course, but there is no real "developers" section in the official docs that I can see, and it's even called "CKAN's Administration Guide".
comment:8 Changed 2 years ago by rgrp
Hmmm. Emerging consensus from discussions in last few months is that wiki is fairly confusing and we should move core, solid docs (from whichever area) to the main docs.
Furthermore, key dev info like how to setup and do extensions *is* already in the main docs (see http://docs.ckan.org/en/latest/writing-extensions.html) and has been for 6m+. I've created #2226 for more work on docs and you may wish to comment there.
John: can you comment on status here. Have you already got docs for this?