Dryad's basic documentation philosophy includes 4 levels of visibility:
- "Very" public documents -- High-level descriptions and information, on the Main Dryad website
- Public documentation -- Technical documents and other details about dryad. Stored in Github, usually within this directory
- Private documentation -- Internal details, for Dryad staff. Stored in Confluence.
- Private working documents -- Documents that are edited frequently. Stored in Dryad's Google Dive.
Our demo instance of Dryad is available at https://dryad-stg.cdlib.org and you may submit and test freely.
-
The main application for Dryad is at https://github.com/CDL-Dryad/dryad-app with minor customizations and configuration for an installation.
-
The stash_engine and stash_datacite modules hold most of the code for the user interface.
-
The stash_api module is where we've implemented our API.
-
The stash_discovery module is a relatively thin wrapper and customization around Geoblacklight.
-
-
We have an installation guide for installing the user-interface part of Dryad along with some of the basic depedencies.
-
A basic generalized introduction to Dryad's architecture is available at https://datadryad.org/stash/our_platform .
-
A (somewhat dated) database Entity-Relationship diagram.
-
Note most things are related to stash_engine_resources if you have trouble following all the lines. stash_engine_identifiers has many resources.
-
"dcs" means DataCite Schema
-
-
Dataset submission flow, one of our longest and more complicated flows. (Login is also somewhat complicated, but people don’t spend a lot of time doing it.)
-
The UI Library from the UX team and how to integrate CSS and major UI changes into the Dash application. https://github.com/CDL-Dryad/dryad-app/blob/main/ui-library/README.md
-
Please see how to set up and run tests locally so you can add tests and run current tests to be sure nothing breaks.
- Development progress is tracked in the GitHub CDL-Dryad Development Tracker