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

Added docs for the my descriptions page

This commit is contained in:
Thomas Georgios Giannos 2024-07-17 14:07:43 +03:00
parent 616b66d010
commit bb880632c2
1 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/docs/documentation/application/descriptions/my-descriptions.md Normal file
View File

@ -0,0 +1,32 @@
---
sidebar_position: 9
description: View, search and manage your descriptions
---
# My Descriptions
The user can view the descriptions he has created or is a contributor on their [plans](/docs/documentation/application/plans/). The basic information of the descriptions 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 description, the `grant` that is related with the description (the plan), if any, and the role he has on its plan. The plan the descriptions are part of is also displayed. At the bottom of the cards, the user has access to all the actions he can perform on the descriptions, 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/descriptions/exports).<br/>*Every collaborator can do this.*
- **Invite**: This is where the user can invite others to collaborate on the description. More information is available on the [collaboration](/docs/documentation/application/descriptions/collaborations) section.<br/>*Only the collaborators with the role `Owner` can do this*
- **Copy Description**: More information is available in the [description lifecycle](/docs/documentation/application/descriptions/description-lifecycle) section.<br/>*Only the collaborators with the role `Owner` can do this*
- **Delete**<br/>*Only the collaborators with the role `Owner` can do this*
## Filtering and searching
Using the searchbox above the description cards on the right, you can search for descriptions by text.
There are also a lot of filtering choices for the descriptions. 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`, `canceled` or everyone.
- **Related Descriprion Templates**: Filter descriptions based on the [templates](/docs/documentation/application/templates) they are using.
- **Related Plans**: Filter descriptions based on the [plans](/docs/documentation/application/plans/) they are part of.
- **Role**: Filter descriptions based on the role the user has on their plans.
- **Tags**: Filter descriptions based on their attached tags.
- **Reference Types**: Filter descriptions 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.