From 55fb41e4968a95f703bb7e34063aa927b594555b Mon Sep 17 00:00:00 2001 From: Camille Moinier Date: Fri, 13 Oct 2023 11:27:29 +0200 Subject: [PATCH] chore(me): add docs --- docs/apps/editor.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/apps/editor.md b/docs/apps/editor.md index e53d148ff2..0e67017ee6 100644 --- a/docs/apps/editor.md +++ b/docs/apps/editor.md @@ -4,6 +4,17 @@ outline: deep # Editor -## Chapter 1 +## My organization + +The "my organization" tab contains filtered records owned by the organization of the logged in user. Note that this page will not display any records if no user is logged in. +The page is made of : + +- The organization name and logo, fetched from `organisations$` in the `OrganizationServiceInterface`. +- A table with the filtered records. The table is from the component `md-editor-records-list`, which does the fetching of the records. +- Two links : + - The first link is the count of published records for this organization. It leads to the datahub, where the filter by organization will be activated to only show the user's organization. The filter is set through the URL directly with the name from `organisations$`. + - The second link is the count of users for this organization. It leads to a new page in the dashboard. The page is also made of the organization's name and logo, and of a table presenting the users and their details. These users are fetched from the observables `user$` (logged in user), and `allUsers$` (all users of geonetwork) in the `AuthService`. `allUsers$` are then filtered by their organization to be displayed here. The table in this page is also from the component `md-editor-records-list`, which detects if an input `users` (containing the list of filtered users) was received and creates the table accordingly. + +It's important to know that a user with an organization must be logged in for this component to work. If not, or in the case where the organization doesn't own any records, a message will be displayed instead of the table, to inform the user. ## Chapter 2