[ECODP-dev] Documentation

Tue Oct 8 07:55:51 UTC 2013

Darwin, 

As a prime contractor we're in the lead for the ODP project, hence you are
fully right pointing out that we do have the responsibility for collating
and editing the documentation. 

However we do expect - in line with the effort distribution (*) - that the
OKF contributions concerning CKAN are 

a)      Comprehensive and fully address the subject in all its facets 

b)      In case of referral to existing documentation, the relevant sections
are highlighted or copywriting is done in such a way that indeed TF can
collate and edit this into the overall documentation

It is PO's goal to conclude the project with the receipt of documentation
which captures their implementation of the project. 

In some cases the current generic documentation of CKAN might fall short and
hence the attribution of additional mandays to elaborate on documentation
(*).

(*) For reference 

ID

Title

TF

OKF

ULEI

Tot

Cat

Release

Description

17

Final Handover (Doc,training, support) to other party, 4 months duration

50

20

7

77

OVER

M24

Documentation
Training
Workshop
Q&A

Deliver remaining contractual deliverables as specified in the contract.

Best Regards, 

Jurgen Vannerom

Project Manager   

E-mail:    <mailto:jurgen.vannerom at tenforce.com>
jurgen.vannerom at tenforce.com

Phone:  

Mobile: +32 497591362

Skype:   Belgium2003

From: ecodp-dev-bounces at lists.okfn.org
[mailto:ecodp-dev-bounces at lists.okfn.org] On Behalf Of Darwin Peltan
Sent: maandag 7 oktober 2013 18:32
To: Project list for EC ODP CKAN project
Subject: Re: [ECODP-dev] Documentation

Hi Bert,

Thanks for your email. As discussed previously we expect that 10F will lead
on collating and editing the documentation and we will feed in with
information that can be incorporated where there are specific questions
about CKAN. This is Gavin and Laura's understanding too.

Here's my initial response to the list below. 

On 30 September 2013 10:57, Bert Van Nuffelen
<bert.van.nuffelen at tenforce.com> wrote:

Hi John and Darwin,

as promised a list of documentation efforts 

*) Operations Manual:

     * documentation of the CKAN configuration file

The CKAN configuration file is documented in the CKAN docs here
http://docs.ckan.org/en/ckan-1.8/configuration.html and this can be linked
to from the operations manual.

     * documentation of the CKAN translation process

We will provide some notes on this which you can incorporate in the
operations manual.  

     * documentation of the CKAN database management

The CKAN database is a standard Postgres DB so this seems like a general
systems administration area? I think you have created some helper scripts
for some common DB operations as part of the deployment and migration
process so you would be best placed to document this.

     * documentation of the CKAN miscellanous items

          -- here are items collected around questions PO has/had. Maybe
some should move to the appropriate section

We have previously provided documentation for any custom functionality. Do
you have any specific questions relating to this?

     * documentation of the CKAN controlled vocabularies (note I did you
copied from the google doc as I wanted to have the section covering all
items.)

This has already been supplied?

*)  Portal Architecture:

    * Navigation flow chart of the CKAN web interface

10F should document this. 

    * creating/deleteing a tab in CKAN (to match the creation/deletion in
Drupal)

We will provide some notes 

*) Performance criteria

     ODP-257: define tests and performance tuning parameters

This query relates to system administration of Tomcat which is outside our
area of expertise and responsibility as previously discussed. 

*) Security
     description of the different user roles and groups (part of this info
is already present in the Operations Manual) 

> What security is in place for preventing hack & attack (authentication,
authorization, encryption of passwords in DB, HTTPS connections, captcha,
architecture separation between key modules. )

> What audit mechanism is in place to trace user access

Again this question is about the architecture of the overall system which
10F. We will give some background on CKAN security to feed into this. 

kind regards,

Bert

Best,

Darwin 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.okfn.org/mailman/private/ecodp-dev/attachments/20131008/2bf4a49e/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: image001.png
Type: image/png
Size: 17552 bytes
Desc: not available
URL: <https://lists.okfn.org/mailman/private/ecodp-dev/attachments/20131008/2bf4a49e/attachment-0001.png>