diff --git a/docs/maintenance/architecture/curation.md b/docs/maintenance/architecture/curation.md index 1dc66655..04c2f75c 100644 --- a/docs/maintenance/architecture/curation.md +++ b/docs/maintenance/architecture/curation.md @@ -19,6 +19,19 @@ Checks provide a way to run automated verification on draft review requests and Checks, as designed, cannot be run on a draft without both a community and a request. +The diagram below illustrates the relationship between the different concepts for one example community. + +![A tree diagram showing the relationship between check configs, runs, results and rule results](./img/checks.svg) + +Communities can have multiple CheckConfigs, for different types of checks, and each time a check is run on a record it creates a CheckRun. As such, when a record is submitted to a community with checks enabled, there will be N new CheckRuns (where N = number of CheckConfigs). + +Each CheckRun has a CheckResult, which can contain the results for many rules within it. Below is an example of the display of a CheckResult in the Checks tab of a request + +![The UI displays the Check Configs and the Rule Results](./img/checks_ui.jpg) +/// caption +Curation checks in Zenodo's EU Open Research Repository +/// + ## Check Config A check config defines the parameters for a check in a community. Note that each [type of check](#check-component) requires a separate config so there can be multiple per community. See the [Operate an Instance](../../operate/customize/curation-checks.md) documentation for usage details. diff --git a/docs/maintenance/architecture/img/checks.svg b/docs/maintenance/architecture/img/checks.svg new file mode 100644 index 00000000..eb3177f3 --- /dev/null +++ b/docs/maintenance/architecture/img/checks.svg @@ -0,0 +1,134 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Community + + CheckConfig(MetadataCheck) + CheckConfig(FileFormatsCheck) + CheckConfig(...) + CheckRun + CheckRun + CheckRun + CheckResult + CheckResult + CheckResult + + + RuleResult + RuleResult + RuleResult + + + + + + + + + + + + + + + + + + CheckRun + CheckResult + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/maintenance/architecture/img/checks_ui.jpg b/docs/maintenance/architecture/img/checks_ui.jpg new file mode 100644 index 00000000..6b5930de Binary files /dev/null and b/docs/maintenance/architecture/img/checks_ui.jpg differ