Student assistant issue: CKAN fields extension

[adibaba]

Description: The DICE group wants to provide metadata of developed datasets to the public. Therefore, we will provide a CKAN system. The installation instructions are ready, the CKAN system will be deployed soon. This will open up an automatic indexing of our datasets to Google dataset search.

Problem: The default metadata fields do not require our requirements: We need additional fields.

Task 1: Local installation on your computer

• Use docker-compose to install the DICE-CKAN.
• You can use the instructions in the DICE CKAN readme.
• You can leave out step 3, 5, 7.

Task 2: Create extension

The goal is to have additional fields when creating/editing datasets. Instead of having custom fields, pre-definded fields are required, as indicated in the following image:

• Read Customizing dataset and resource metadata fields using IDatasetForm
• Create an extension using the Writing extensions tutorial. (There is some example code which could be helpful.)
• The the fewer methods that are overwritten, the better. (For maintenance, keep it simple)
• A test field to add is
  • key: extra:publisher_uri
  • title: Publisher URI
  • default value: https://dice-research.org/

Task 3: Add fields

• Add required fields like specified in the ckanext-dcat mapping.
• Required before: Call with Adrian to discuss required fields.
• Update 2021-04-19: Here is the spreadsheet: https://docs.google.com/spreadsheets/d/1zitriaA7cH4iRZ46IfB3r3LrpmUI-9ayAJvPHxzS93M/edit?usp=sharing

Task 4: Validation

• On your local CKAN installation, create a dataset and a resource (in DCAT called distribution)
• Check, if the Google Dataset Search Tools Markup helper and Rich Results Tests return positive feedback. (Upload exported data from your system somewhere)
• Check if the exported DCAT catalog (http://localhost:5000/catalog.ttl) are conform with the DCAT specification. This should be the case as stated in ckanext-dcat mapping).

Task 5: Documentation

Create a README.md file and describe how to install the extension on a DICE-CKAN system.

[adibaba]

Update: I just added the spreadsheet link at "Task 3"

[adibaba]

https://github.com/dice-group/dice-ckanext

[adibaba]

How to edit resources: https://stackoverflow.com/questions/26061386/adding-extra-fields-to-ckan-resources