Service Development Guide

LINDAT/CLARIN Service Conditions

We maintain highly available services and put emphasis on their stability, maintainability and support. Conditions below reflect that. It is also a matter of principle for LINDAT, as a publicly funded project, to provide Open Source software and support Open Access movement.

This is what we require from a project to consider running it as a supported LINDAT/CLARIN Service:

• Open Source Code
  • Clear OSI-Approved License. If you need help choosing a license, you can use our Public License Selector
  • Public version control repository and bug/issue tracker. Github, Bitbucket, Launchpad, whatever you like.
• Documentation
• Reasonable code quality (our judgement)
• Responsive maintainer
• REST API (or willingness to implement one with our help) including documentation
  • if applicable
• Graphical user interface with LINDAT common theme header/footer
• Software and the data used by the service should be individually deposited in a digital repository (e.g., https://lindat.mff.cuni.cz/repository/xmlui/)
• (Optional) using other components from LINDAT common theme e.g., RefBox
• (Optional) If your service needs authentication, login via academic federation (i.e. with user's home institution account) must be supported. We can help with this.

Service Setup

• the service must run on the quest cluster - contact lindat-technical@ufal
  • the service can have its own VM with root access
• use LINDAT common theme - https://github.com/ufal/lindat-common/
  • make sure it gets updated regularly e.g., using cron
• create web page including documentation and send the link to lindat-technical@ufal
  • we will make a proxy from lindat.mff.cuni.cz/services/XXX
• fill out the following template in Czech and English and send it to lindat-technical@ufal
  • title, authors, description, logo, project url, service url, PID (handle) to repository record
  • see https://lindat.mff.cuni.cz/en/services