This repository has been archived by the owner on Apr 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
CEDAR technical documentation
Martin O'Connor edited this page Apr 4, 2023
·
53 revisions
- CEDAR Repository Model. This document describes the CEDAR repository model, which defines the representation of all CEDAR metadata artifacts, such as templates, elements, fields and the metadata instances themselves. A quick introduction to this model can be found in the following paper.
- CEDAR Metadata Instances. Description of programmatically creating CEDAR template, element and field instances.
- CEDAR Templates, Elements and Fields. Description of programmatically creating CEDAR templates, elements and fields.
- Getting Started with CEDAR REST APIs. Instructions for interacting with CEDAR REST services
- Processing CEDAR Metadata Instances. Examples of how JSON Schema-based code generation tools can be used to read and write CEDAR metadata instances.
- CEDAR User Guide. (In progress) This is the main user guide for the CEDAR system.
- CEDAR Value Recommender. This short guide describes the steps to enable recommendations for templates and use them to quickly and accurately create new metadata.
- BioPortal API documentation. CEDAR uses BioPortal for all terminology services.
- CEDAR Project Proposal
- CEDAR Architecture Diagram
- CEDAR Release Notes
General-purpose links to the tools that we use for developing our system.
(Links are to our general site. See the Team page for links to our accounts.)
- ZenHub. Used for tracking all CEDAR development tasks.
- GitHub Developer Wiki. Developer-centric CEDAR wiki.
- Google Drive. Used for document authoring; completed documents are transferred to Box, public documents are made visible to all via Google Drive.
- Slack. Used for development discussions
- Elasticsearch (Search Engine)
- Nginx (HTTP Server)
- Keycloak (Identity and Access Management)
- OmniGraffle (Diagrams and Graphics)
- StarUML (UML Diagrams)
Publicly available documentation about the project.
- CEDAR Git Workflow. The CEDAR development team uses the Git-Flow model
CEDAR issues are tracked in each of the above repositories. To get an overview, you'd want to look at our Agile display of those issues, using the recommended ZenHub software.
- Agile task board, ZenHub, synced with GitHub issues
More information about the information model specifications we've applied.
JSON Schema and JSON-LD are used extensively in CEDAR.
- Understanding JSON Schema (book)
- JSON-LD Playground
- Validators
- JSON validator (online): http://jsonlint.com
- JSON validator (Python, command line): http://deron.meranda.us/python/demjson/
- JSON Schema validator (online): http://jsonschemalint.com/draft4
- JSON Schema validator (Python, command line): http://python-jsonschema.readthedocs.org/en/latest/validate
- Viewers
- Online JSON viewer: http://jsonviewer.stack.hu
Interoperation with RDF and Linked Open Data is a core CEDAR goal.