MaDgiK-CITE
/
argos
13
0
Fork 0
Code Issues Pull Requests Projects Releases 3 Wiki Activity

Improved annotation docs on docusaurus, added docs for the my plans page

This commit is contained in:
Thomas Giannos 2024-07-17 12:07:04 +03:00
parent 3d8a654dbd
commit 4669e8c778
2 changed files with 43 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/docs/documentation/application/plans/my-plans.md Normal file
View File

@ -0,0 +1,34 @@
---
sidebar_position: 10
description: View, search and manage your plans
---
# My Plans
The user can view the plans he has created or is a contributor. The basic information of the plans is displayed in a card format. At the top of the cards, the `name` and the `date` of creation or update are displayed. At the main body of the cards, the user can view the `status` of the plan, the `version`, the `grant` that is related with the plan, if any, and the role he has on it. The [descriptions](/docs/documentation/application/descriptions/) are also listed, along with their total count. At the bottom of the cards, the user has access to all the actions he can perform on the plans, based on his plan spesific role.
## User actions
Let's explore these actions and what privileges they require.
- **Export**: With this option, a dropwown containing all the export options pops up. You can view more details on the exports [here](/docs/documentation/application/plans/exports).<br/>*Every collaborator can do this.*
- **Add Description**: From here, the user gets redirected to the [edit page](/docs/documentation/application/plans/edit-a-plan) of the plan where he can add [descriptions](/docs/documentation/application/descriptions/).<br/>*Only the collaborators with the role `Owner` can do this*
- **Invite**: This is where the user can invite others to collaborate on the plan. More information is available on the [collaboration](/docs/documentation/application/plans/invite-collaborators) section.<br/>*Only the collaborators with the role `Owner` can do this*
- **Clone**<br/>*Only the collaborators with the role `Owner` can do this*
- **Delete**:<br/>*Only the collaborators with the role `Owner` can do this*
- **New Version**: More information is available in the [versioning](/docs/documentation/application/plans/versions) and the [plan lifecycle](/docs/documentation/application/plans/plan-lifecycle) sections.<br/>*Only the collaborators with the role `Owner` can do this*
- **All Plan Versions**: From here, the user gets redirected to a listing with all the versions of the plan.<br/>*Every collaborator can do this.*
## Filtering and searching
Using the searchbox above the plan cards on the right, you can search for plans by text.
There are also a lot of filtering choices for the plans. The filtering options are displayed in a sidebar at the right side of the screen when the user clicks on the respective `filtering` handle and they are the following:
- **Status**: Show only plans that are saved as a `draft`, are `finalized` or everyone.
- **Related Descriprion Templates**: Filter plans based on the [templates](/docs/documentation/application/templates) their [descriptions](/docs/documentation/application/descriptions/) are using.
- **Related Plan Blueprints**: Filter plans based on their [blueprint](/docs/documentation/application/blueprints).
- **Role**: Filter plans based on the role the user has on them.
- **Reference Types**: Filter plans based on their [references](/docs/documentation/application/references). You can filter using more than one references by clicking the `Add a Reference Type` button and selecting your reference.
When done setting the filters, the button `Apply filters` located at the bottom of the sidebar must be pressed.

10
docs/docs/documentation/supplementary-services/annotations.md
View File

@ -7,6 +7,12 @@ description: Discover everything about the annotations service
The `Annotations Service` is responsible to provide commenting capabilities and communication threads to users, that can be attached to any entity.
Currenty, users can communicate in threads that attach to [description template](/docs/documentation/administration/templates/) questions. There is a `comments` button next to the titles of the questions, which brings up a modal with the threads attached to them when clicked. Here, users can either create new threads or respond to existing ones. Comments can also be flaged as `hidden` which makes them visible only to their authors.
All of the information needed for this functionality is getting handled independently of the main platform, using this service.
All of this information is getting handled independently of the main platform, using this service.
## Usages
Users can communicate in threads that attach to the [plan](/docs/documentation/application/plans/) questions and to the [description template](/docs/documentation/administration/templates/) questions themselves. There is a `comments` button next to the titles of the questions, which brings up a modal with the threads attached to them when clicked. Here, users can either create new threads or respond to existing ones. Comments can also be flaged as `hidden` which makes them visible only to their authors. There is also a number attached to the annotation buttons indicating the count of them, if any.
In addition to simple comments, users can mention other users on their responses by typing the `@` symbol and then select the user they want to mention from the respective dropdown that pops up. When this happens, the mentioned user gets notified.
In conclusion, there is a useful feature where the user can refer to the annotations of a question directly by a link which is generated and copied to his clipboard when he presses the `link` handle at the top right corner of the popup dialog. This link is also present in the notification the mentioned users receive.