diff --git a/docs/docs/documentation/application/descriptions/create-a-description.md b/docs/docs/documentation/application/descriptions/create-a-description.md index ee4d98871..858b5192d 100644 --- a/docs/docs/documentation/application/descriptions/create-a-description.md +++ b/docs/docs/documentation/application/descriptions/create-a-description.md @@ -2,4 +2,26 @@ sidebar_position: 1 --- -# Create a Description \ No newline at end of file +# Create a Description + +There are two ways to create descriptions: +- edit a plan by clicking `Add Description` in specific plan section that contains description templates field + +-img- plan editor in edit state -img- + +- click `Add Description` in `My Descriptions` or `Home` and select in which plan the description will be stored. If plan has more than one description templates fields, must select in which section. + +-img- my descriptions -img- -img- add description dialog -img- + + +When creating a new description a pop up message appears in case you want to automatically obtain answers to certain answers (for more details check [Prefill a Description](/docs/documentation/application/descriptions/prefill-a-description)) or continue manually. + +-img- prefill description pop up dialog -img- + +In each case a Description Editor is provided to add information that describes management activities according to the selected template. If continue manually, must fill **Title** and **Template** of Description in Main Info for a temporary save. When select description template, shows up all the next steps of this. + +-img- description editor -img- + +:::info +To finalize a description must answer all the required questions. If description is not valid for finalization yet, all unanswered required questions are marked to continue editing. +::: diff --git a/docs/docs/documentation/application/descriptions/edit-a-description.md b/docs/docs/documentation/application/descriptions/edit-a-description.md index 96ff6b48d..419f079e6 100644 --- a/docs/docs/documentation/application/descriptions/edit-a-description.md +++ b/docs/docs/documentation/application/descriptions/edit-a-description.md @@ -2,4 +2,18 @@ sidebar_position: 2 --- -# Edit a Description \ No newline at end of file +# Edit a Description + +There are several ways to edit an existing description: + +- either from `Home Page` or from `My Descriptions`. By selecting the description you can view the overview and all actions for this. + +-img- description overview -img- + +- view the `Plan Overview` that contains descriptions and select on of them. + +-img- plan overview -img- + +- edit a plan that contains descriptions and select on of them. + +-img- plan editor in edit state -img- \ No newline at end of file diff --git a/docs/docs/documentation/application/descriptions/exports.md b/docs/docs/documentation/application/descriptions/exports.md index 5ae1ec617..83d8afe16 100644 --- a/docs/docs/documentation/application/descriptions/exports.md +++ b/docs/docs/documentation/application/descriptions/exports.md @@ -2,4 +2,19 @@ sidebar_position: 8 --- -# Exports \ No newline at end of file +# Exports +-img- export plan-img- + +Application supports download the structure of the description in the following formats: +- **PDF** +- **DOCX** +- **RDA JSON** +- **XML** + +:::tip + +- You can use the export feature in anytime in description' lifecycle +- `Export` the button can be used both internally in the form and externally in `Μy descriptions` and `Description Overview` +- Export is also available in Description Plans + +::: \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/create-a-plan.md b/docs/docs/documentation/application/plans/create-a-plan.md index 0842c8c23..b1bc1c22c 100644 --- a/docs/docs/documentation/application/plans/create-a-plan.md +++ b/docs/docs/documentation/application/plans/create-a-plan.md @@ -2,4 +2,17 @@ sidebar_position: 1 --- -# Create a Plan \ No newline at end of file +# Create a Plan + +-img- start a new plan -img- + +To create a new Plan in OpenCDMP you can either [import](/docs/documentation/application/plans/imports) an existing plan from other source or writting a Plan from start. It provides an editor that you must fill **Title**, **Description** and select the [**Blueprint**](/docs/documentation/administration/blueprints/) of this plan that describes the structure. Also there is a Default Plan Blueprint for use. After save, the plan is automatically in draft status. + +-img- plan editor first step -img- + +:::note + +There is a progression bar percentage that counts the completed required fields. To finalize a plan you must fill all the required fields. + +::: +-img- plan editor in new state -img- diff --git a/docs/docs/documentation/application/plans/edit-a-plan.md b/docs/docs/documentation/application/plans/edit-a-plan.md index 5a6239983..96d575dce 100644 --- a/docs/docs/documentation/application/plans/edit-a-plan.md +++ b/docs/docs/documentation/application/plans/edit-a-plan.md @@ -2,4 +2,12 @@ sidebar_position: 2 --- -# Edit a Plan \ No newline at end of file +# Edit a Plan + +You can view a plan by either from `Home Page` or from `My Plans`. By selecting the plan you can view the overview and all actions for this. + +-img- plan overview -img- + +In edit state you can make and revert changes but also add descriptions to specific section that contains description templates field. + +-img- plan editor in edit state -img- \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/exports.md b/docs/docs/documentation/application/plans/exports.md index 5ae1ec617..c22d73e51 100644 --- a/docs/docs/documentation/application/plans/exports.md +++ b/docs/docs/documentation/application/plans/exports.md @@ -2,4 +2,19 @@ sidebar_position: 8 --- -# Exports \ No newline at end of file +# Exports + +-img- export plan-img- + +Application supports download the structure of the plan in the following formats: +- **PDF** +- **DOCX** +- **RDA JSON** +- **XML** + +:::tip + +- You can use the export feature in anytime in plans' lifecycle +- Export is also available in Public Plans + +::: diff --git a/docs/docs/documentation/application/plans/imports.md b/docs/docs/documentation/application/plans/imports.md index 83c89dcbb..ba072d752 100644 --- a/docs/docs/documentation/application/plans/imports.md +++ b/docs/docs/documentation/application/plans/imports.md @@ -2,4 +2,8 @@ sidebar_position: 7 --- -# Imports \ No newline at end of file +# Imports + +You can import an existing plan to continue work in appliation. Import supports upload of `.json` files that are produced according to [RDA specifications](https://github.com/RDA-DMP-Common/RDA-DMP-Common-Standard) for machine-actionable plans. + +-img- import plan pop up dialog -img- diff --git a/docs/docs/documentation/application/plans/invite-collaborators.md b/docs/docs/documentation/application/plans/invite-collaborators.md index 3006e7d3d..a45eacb06 100644 --- a/docs/docs/documentation/application/plans/invite-collaborators.md +++ b/docs/docs/documentation/application/plans/invite-collaborators.md @@ -2,4 +2,22 @@ sidebar_position: 4 --- -# Invite collaborators \ No newline at end of file +# Invite collaborators + +-img- invite users -img- + +Before finalization, the plan can be further edited by inviting users collaborate on completing this. There are two methods to invite users: +- **External**: If user is registered in application then a notification (email or in App) sends to him. If not, a registration email sends. +- **Internal**: It's a quick way, that we can invite users that is already associated to other plans we work with as well. + + +For each member, must be defined the role for the plan. There are three different roles: + +- **Owner**: manage and edit all plan features. +- **Description Contributor**: only edit descriptions of this plan. +- **Reviewer**: view the plan but no rights to edit. + + +:::note +the roles' features can be apply to entire plan or specific section +::: \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/plan-lifecycle.md b/docs/docs/documentation/application/plans/plan-lifecycle.md index 219c4512d..8e1ad4124 100644 --- a/docs/docs/documentation/application/plans/plan-lifecycle.md +++ b/docs/docs/documentation/application/plans/plan-lifecycle.md @@ -2,4 +2,6 @@ sidebar_position: 3 --- -# Plan lifecycle \ No newline at end of file +# Plan lifecycle + +After a plan is created automatically get the draft status. In `My Plans` they appears all the plans that user has or collaborate. \ No newline at end of file diff --git a/docs/docs/documentation/application/plans/versions.md b/docs/docs/documentation/application/plans/versions.md index 82acacc56..5a8f88b77 100644 --- a/docs/docs/documentation/application/plans/versions.md +++ b/docs/docs/documentation/application/plans/versions.md @@ -2,4 +2,17 @@ sidebar_position: 5 --- -# Versions \ No newline at end of file +# Versions + +:::info +If the plan is finalized you can create a new version for it. New Version don't delete the previous version of this plan, just creates a new with draft status. +::: + +`New Version` button exists in `My Plans` or `Plan Overview` actions. In new version form can change the title, description, plan blueprint and optional select which descriptions include in the new version. After the process is completed, plan and descriptions are available to edit. + +-img- new version overview -img- +-img- new version listing -img- + +:::tip +`All Plan Versions` - shows the history of the different versions of the existing plan +::: \ No newline at end of file