alanorth/iseal-core
1
0
Fork 0
mirror of https://github.com/ISEAL-Community/iseal-core.git synced 2024-10-30 20:03:02 +01:00
Code Issues Projects Releases Wiki Activity

README-dev.md: improve introduction

Browse Source
This commit is contained in:
Alan Orth 2022-01-30 12:31:30 +03:00
parent e202cbe3de
commit 88ba512cf1
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README-dev.md
View File

@ -1,6 +1,15 @@
# Technical Documentation
This document provides technical information about various workflows related to updating and editing the schema and documentation site.
## About This Project
The ISEAL Core Metadata Set is maintained primarily in CSV format. This decision was made to maintain a balance between being human and machine readable. Currently the project consists of:
- The ISEAL Core Metadata Set, which lives in `data/iseal-core.csv`
- The FSC<sup>®</sup> extension, which lives in `data/fsc.csv`
From the CSV we use a series of Python scripts to create the RDF ([TTL](https://en.wikipedia.org/wiki/Turtle_(syntax))) representations of the schema as well as the HTML documentation site. All of this is automated using GitHub Actions (see `.github/workflows`) whenever there is a new commit in the repository.
## General Requirements
- Python 3.7+