diff --git a/docs/docs/documentation/application/commons/_category_.json b/docs/docs/documentation/application/commons/_category_.json new file mode 100644 index 000000000..9e26dfeeb --- /dev/null +++ b/docs/docs/documentation/application/commons/_category_.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/docs/docs/documentation/application/commons/_markdown-reviewing.md b/docs/docs/documentation/application/commons/_markdown-reviewing.md new file mode 100644 index 000000000..90f5855d4 --- /dev/null +++ b/docs/docs/documentation/application/commons/_markdown-reviewing.md @@ -0,0 +1,7 @@ +Contributors of a [plan](/docs/documentation/application/plans) can have the `Reviewer` role which grants them read access on the plan and its [descriptions](/docs/documentation/application/descriptions). Reviewers can also publish comments on the questions of the descriptions using the [annotations](/docs/documentation/supplementary-services/annotations) feature. + +:::info + +This role can be granted to as many users as needed. + +::: \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/collaborations.md b/docs/docs/documentation/application/descriptions/collaborations.md index 1791f36d7..330d6317f 100644 --- a/docs/docs/documentation/application/descriptions/collaborations.md +++ b/docs/docs/documentation/application/descriptions/collaborations.md @@ -3,4 +3,12 @@ sidebar_position: 5 description: Discover how collaboration works on descriptions --- -# Collaborations \ No newline at end of file +# Collaborations + +Contributors of a [plan](/docs/documentation/application/plans) can have the `Description Contributor` role which grants them read access on the plan and its [descriptions](/docs/documentation/application/descriptions). Description Contributors can also add or edit existing descriptions. + +:::info + +This role can be granted to as many users as needed for collaboration. + +::: \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/description-lifecycle.md b/docs/docs/documentation/application/descriptions/description-lifecycle.md index 8d7fd59fe..00434f4ae 100644 --- a/docs/docs/documentation/application/descriptions/description-lifecycle.md +++ b/docs/docs/documentation/application/descriptions/description-lifecycle.md @@ -3,4 +3,8 @@ sidebar_position: 4 description: Discover the lifecycle of a description --- -# Description Lifecycle \ No newline at end of file +# Description Lifecycle + +After a description is created, it gets saved automatically in `draft` mode. While in this mode, the user can make any changes he wants and save it as many times as he wants. When ready, the user can then `finalize` it which means no more changes will be possible. If there comes a need for further editing after the description is already finalized, the user has the option to undo the finalization and bring it back into `draft` mode. + +In the `My Descriptions` page, the user can view all the descriptions he has created or the ones that are related with [plans](/docs/documentation/application/plans) he has been invited as a [collaborator](/docs/documentation/application/plans/invite-collaborators). \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/imports.md b/docs/docs/documentation/application/descriptions/imports.md index 3df360d48..14d111a59 100644 --- a/docs/docs/documentation/application/descriptions/imports.md +++ b/docs/docs/documentation/application/descriptions/imports.md @@ -3,4 +3,6 @@ sidebar_position: 7 description: Discover import options for a description --- -# Imports \ No newline at end of file +# Imports + +Description imports are not possible directly, but during the [import](/docs/documentation/application/plans/imports) of a plan, the descriptions that are related with it, get imported as well. \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/prefill-a-description.md b/docs/docs/documentation/application/descriptions/prefill-a-description.md index cf668e9ce..b6f2f969e 100644 --- a/docs/docs/documentation/application/descriptions/prefill-a-description.md +++ b/docs/docs/documentation/application/descriptions/prefill-a-description.md @@ -3,4 +3,10 @@ sidebar_position: 3 description: Discover how to prefill a description to save time --- -# Prefill a Description \ No newline at end of file +# Prefill a Description + +There is a way to prefill some basic information on your description during its creation. When you add a description on a plan, you get greeted by a modal where you can select if you want to use a [prefilling source](/docs/documentation/administration/blueprints/prefilling-configurations.md) or you want to fill all the questions manually. If you choose to prefill, then you will have to choose the [description template](/docs/documentation/administration/templates) you want to use and the prefilling source. + +## How does it work? + +The fields of the questions on a description template can have [semantics](/docs/documentation/administration/templates/semantics) attached. These semantics are then used to fetch the relevant information from the source of your choice and prefill these fields for you. \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/reviewing.md b/docs/docs/documentation/application/descriptions/reviewing.md index ef264de8c..3339e4ad7 100644 --- a/docs/docs/documentation/application/descriptions/reviewing.md +++ b/docs/docs/documentation/application/descriptions/reviewing.md @@ -3,4 +3,8 @@ sidebar_position: 6 description: Discover how to review a description --- -# Reviewing \ No newline at end of file +# Reviewing + +import Reviewing from '../commons/_markdown-reviewing.md'; + + \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/doi-assignment.md b/docs/docs/documentation/application/plans/doi-assignment.md index af5c1c8ed..50e7f9010 100644 --- a/docs/docs/documentation/application/plans/doi-assignment.md +++ b/docs/docs/documentation/application/plans/doi-assignment.md @@ -3,4 +3,9 @@ sidebar_position: 9 description: Discover how to publich a plan and aquire a DOI --- -# DOI Assignment \ No newline at end of file +# DOI Assignment + +Every time a Plan gets deposited, it gets assigned a **DOI** (**D**ata **O**bject **I**dentifier) from the [deposit service](/docs/documentation/supplementary-services/deposit-services). After the successful deposit, the DOI is available in the Plan overview page, alongside the service in which it got deposited. + +![Plan overview](https://fakeimg.pl/600x400) +*Plan overview* \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/reviewing.md b/docs/docs/documentation/application/plans/reviewing.md index bd449322a..f57902064 100644 --- a/docs/docs/documentation/application/plans/reviewing.md +++ b/docs/docs/documentation/application/plans/reviewing.md @@ -3,4 +3,8 @@ sidebar_position: 6 description: Discover how to review a plan --- -# Reviewing \ No newline at end of file +# Reviewing + +import Reviewing from '../commons/_markdown-reviewing.md'; + + \ No newline at end of file diff --git a/docs/docs/documentation/supplementary-services/file-transformers.md b/docs/docs/documentation/supplementary-services/file-transformers.md index 074d1d567..d995f8a00 100644 --- a/docs/docs/documentation/supplementary-services/file-transformers.md +++ b/docs/docs/documentation/supplementary-services/file-transformers.md @@ -10,4 +10,4 @@ The `File Transformer Services` are standalone services responsible to provide a There are currently two file transformer services implemented and integrated. - **Docx file transformer service**: Used for PDF files and Word documents. -- **Rda file transformer service**: Used for JSON files following the RDA specification. \ No newline at end of file +- **Rda file transformer service**: Used for JSON files following the [RDA specification](https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard). \ No newline at end of file