doap-workshop

๐Ÿงญ A workshop to get familiar with FAIR, DOAP and IDS Dashboard website

Descriptors DOAP

A critical component of project reusability is providing standard metadata descriptors. Thus, adding DOAP descriptors will greatly improve the reusability of the project. We hope that adopting DOAP schema will lead search engines and other applications to give users direct access to the project, and thus increase visibility.

Each projectโ€™s owner provides a DOAP with a list of โ€œdescriptorsโ€ to categorize each release, describing who itโ€™s for, what systems it can run on, and how mature it is. It is noteworthy that some of the descriptors could be not useful for you and thereby, they can be empty.

Example 1: Fairsharing Metrics


๐Ÿ“‹ Project information

The selection of project type strictly depends on the project content. In this case, the project is categorized in โ€œResearchโ€ type.

๐Ÿ—‚๏ธ Type of project doap: category
๐Ÿงช Research A folder that contains all your โ€œResearchโ€ related projectโ€™s file

The descriptor for project type is category and will look like the following:

doap:category "Research" ;

The next step is to select the status of your project. The table below shows the current definition for each status.

โœ”๏ธ Status of the project bibo:status
๐Ÿš€ Active The project is being actively developed since the first commit. Project Status: Active - A IDS project is a publicly available code concerning IDS grants in varying state of usability, development and support..
๐Ÿ—‘๏ธ Inactive The project is no longer being actively developed, support/maintenance. Project Status: Inactive- A IDS project is a publicly available code concerning IDS grants in varying state of usability, development and support..
๐Ÿšง Work in Progress* Initial development is in progress, but there has not yet been a stable, usable release suitable for the public. Project Status: WIP- Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.

*๐Ÿšงnot yet available in the list (TBD)

The status of a project has been gathered from bibo ontology and will look like this:

bibo:status "Active" ;

From this point onward, the necessary information can be directly gathered from the Github repository.

๐ŸŽฌ Project name Typically the title of the README.md
doap: name doap:name "Fairsharing Metrics" ;
๐Ÿ”– Project description Typically the title of the Github About repository details
doap: description doap:description "A Dockerization of the Fairsharing metrics as a module for Data Quality Analysis."
โš–๏ธ License URL Add a license of the LICENSE.md repository details. Or chose a popular license here
doap: license doap:license <https://github.com/MaastrichtU-IDS/fairsharing-metrics> ;
โ˜• Programming languages A full list of programming languages we accept is available in the form. Feel free to customize your doap file as best your convenience
doap: programming-language doap:programming-language "Python" ;

๐Ÿ’พ Git repository URL (GitHub/GitLab) URL location of your repository
doap: repository doap:location <https://github.com/MaastrichtU-IDS/fairsharing-metrics> ;
๐Ÿšง Issue tracker URL URL location of your issue tracker
doap:bug-database doap:bug-database <https://github.com/MaastrichtU-IDS/fairsharing-metrics/issues> ;
๐Ÿ  Project homepage URL URL location of your website
doap: homepage doap:homepage <https://github.com/MaastrichtU-IDS/fairsharing-metrics> ;
๐Ÿ ๐Ÿ“– Project wiki URL location of your project wiki
doap: wiki doap: wiki <https://github.com/MaastrichtU-IDS/fairsharing-metrics/wiki>
๐Ÿ“ฅ Project download page URL location of your downloadable package
doap: download-page ย 
๐Ÿ›ฉ๏ธ Service endpoint URL URL location of your endpoint service
doap: service-endpoint ย 
๐Ÿ’ฌ Mailing list or community chat URL URL location of your chat channel and communication
doap:mailing-list ย 

๐Ÿ‘ค Contact details

๐Ÿท๏ธ Contributor name Name and Surname of the project owner
foaf:name foaf:name "Vincent Emonet" ;
๐Ÿ“ฌ Contributor email Email of the project owner
foaf:mbox foaf:mbox <mailto:vincent.emonet@maastrichtuniversity.nl>

Feel free to manually add more DOAP project properties or contributors after downloading the turtle file.