More fixes on plans and descriptions docs
This commit is contained in:
parent
7790d19818
commit
560ba3a11a
|
|
@ -6,23 +6,32 @@ description: Discover how to create a new description
|
|||
# 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-
|
||||
- Edit a plan by clicking `Add Description` in a specific section.<br/>*You can only add a description in sections that have a description template assigned*.
|
||||
|
||||
- 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.
|
||||
|
||||
*Plan editor*
|
||||
|
||||
-img- my descriptions -img- -img- add description dialog -img-
|
||||
- Click `Add Description` in the `My Descriptions` or the `Home` page and select in which plan the description will be stored. If the plan has more than one description templates assigned, you will have to also select a specific section.
|
||||
|
||||
|
||||
*My descriptions*
|
||||
|
||||
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.
|
||||
|
||||
*Add description dialog*
|
||||
|
||||
-img- prefill description pop up dialog -img-
|
||||
When creating a new description, a pop up message appears in case you want to automatically obtain answers from external sources (for more details check [Prefill a Description](/docs/documentation/application/descriptions/prefill-a-description)) or continue manually.
|
||||
|
||||
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.
|
||||
|
||||
*Description prifilling popup dialog*
|
||||
|
||||
-img- description editor -img-
|
||||
In either case, a `Description Editor form` is provided to add information according to the selected template. If you selected to continue manually, you must fill the **Title** and the **Template** of your description in the `Main Info` section of the form. This information is required even for a temporary (`draft`) save. When you select a description template, you can then proceed to the next sections of the form.
|
||||
|
||||
|
||||
*Description editor*
|
||||
|
||||
:::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.
|
||||
|
||||
To `finalize` a description, you must answer all the required questions. If the description is not valid for finalization yet, all unanswered required questions are marked red and you will have to continue editing.
|
||||
|
||||
:::
|
||||
|
|
|
|||
|
|
@ -7,14 +7,17 @@ description: Discover how to 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.
|
||||
- From the `Home Page` or from the `My Descriptions` page. By selecting a description, you can view the overview and all the available actions for it.
|
||||
|
||||
-img- description overview -img-
|
||||
|
||||
*Description overview*
|
||||
|
||||
- view the `Plan Overview` that contains descriptions and select on of them.
|
||||
- View the `Plan Overview` page of a plan that contains descriptions, and select one of them.
|
||||
|
||||
-img- plan overview -img-
|
||||
|
||||
*Plan overview*
|
||||
|
||||
- edit a plan that contains descriptions and select on of them.
|
||||
- Edit a plan that contains descriptions and select one of them.
|
||||
|
||||
-img- plan editor in edit state -img-
|
||||
|
||||
*Plan editor*
|
||||
|
|
@ -4,14 +4,16 @@ description: Discover export options for a description
|
|||
---
|
||||
|
||||
# Exports
|
||||
-img- export plan-img-
|
||||
|
||||
Application supports download the structure of the description in the following formats:
|
||||
You can export the structure of a description in the following formats:
|
||||
- **PDF**
|
||||
- **DOCX**
|
||||
- **RDA JSON**
|
||||
- **XML**
|
||||
|
||||
|
||||
*Export descriptions*
|
||||
|
||||
:::tip
|
||||
|
||||
- You can use the export feature in anytime in description' lifecycle
|
||||
|
|
|
|||
|
|
@ -5,17 +5,21 @@ description: Discover how to create a new plan
|
|||
|
||||
# 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 a file or fill in a Plan from the start.
|
||||
|
||||
|
||||
*New plan popup dialog*
|
||||
|
||||
To do this, there is a form available where you must fill a **Title**, a **Description** and select the **[Blueprint](/docs/documentation/administration/blueprints/)** of this plan that describes its structure. Also, there is a Default Plan Blueprint for use. When ready, after you press `save`, the plan is automatically saved having the `draft` status. More information about the lifecycle of a plan, can be found [here](/docs/documentation/application/plans/plan-lifecycle).
|
||||
|
||||
-img- plan editor first step -img-
|
||||
|
||||
*Plan editor (first section)*
|
||||
|
||||
:::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-
|
||||
|
||||
|
||||
*Plan editor progress bar*
|
||||
|
|
|
|||
|
|
@ -7,8 +7,10 @@ description: Discover how to edit a plan
|
|||
|
||||
You can view a plan either from `Home Page` or from `My Plans`. By selecting the plan you can view the overview and all the actions available for it.
|
||||
|
||||
-img- plan overview -img-
|
||||
|
||||
*Plan overview*
|
||||
|
||||
While in the edit view, you can make and revert changes but also add descriptions to specific sections that contain description template fields.
|
||||
|
||||
-img- plan editor in edit state -img-
|
||||
|
||||
*Plan editor*
|
||||
|
|
@ -5,14 +5,15 @@ description: Discover export options for a plan
|
|||
|
||||
# Exports
|
||||
|
||||
-img- export plan-img-
|
||||
|
||||
You can export the structure of a plan in the following formats:
|
||||
- **PDF**
|
||||
- **DOCX**
|
||||
- **RDA JSON**
|
||||
- **XML**
|
||||
|
||||
|
||||
*Export plans*
|
||||
|
||||
:::tip
|
||||
|
||||
- You can use the export feature anytime in a plans' lifecycle
|
||||
|
|
|
|||
|
|
@ -7,4 +7,5 @@ description: Discover import options for a plan
|
|||
|
||||
You can import an existing plan so that you don't have to work on a new one from scratch. Import supports the 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-
|
||||
|
||||
*Import plan popup dialog*
|
||||
|
|
|
|||
|
|
@ -5,19 +5,20 @@ description: Discover how you invite people to a plan
|
|||
|
||||
# Invite collaborators
|
||||
|
||||
-img- invite users -img-
|
||||
|
||||
Before finalization, the plan can be further edited by inviting users in order to collaborate on it and complete it. There are two methods to invite users:
|
||||
|
||||
- **External**: If the user is registered in the application, then a notification (email or in App) gets sent to him. If not, a registration email is being sent instead.
|
||||
- **Internal**: It's a quick way, that we can invite users already associated to other plans we work with as well.
|
||||
|
||||
|
||||
*Invite users*
|
||||
|
||||
For each member, a role on the plan must be defined. There are three different roles:
|
||||
|
||||
- **Owner**: Manage and edit all plan features.
|
||||
- **Description Contributor**: Edit only the descriptions of this plan.
|
||||
- **Reviewer**: View the plan without being able to edit it.
|
||||
|
||||
|
||||
:::note
|
||||
|
||||
The collaboration roles we discussed above, can be applied to an entire plan or only to a specific section of it.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,4 @@ If the plan is finalized you can create a new version for it, which will have al
|
|||
|
||||
:::
|
||||
|
||||
The `New Version` option cab be found in the `My Plans` or `Plan Overview` pages. In the new version form, the user can change titles, descriptions, plan blueprints and optionally select which descriptions to include in the new version. After the process is completed, the new plan and descriptions are available for editing.
|
||||
|
||||
-img- new version overview -img-
|
||||
-img- new version listing -img-
|
||||
The `New Version` option can be found in the `My Plans` or `Plan Overview` pages. In the new version form, the user can change titles, descriptions, plan blueprints and optionally select which descriptions to include in the new version. After the process is completed, the new plan and descriptions are available for editing.
|
||||
|
|
@ -33,6 +33,17 @@ p {
|
|||
text-align: justify;
|
||||
}
|
||||
|
||||
article img {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
article img + em {
|
||||
display: block;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.outer-tab {
|
||||
margin-left: 1rem;
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue