Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs #146

Open
wants to merge 28 commits into
base: development
Choose a base branch
from
Open

chore: update docs #146

wants to merge 28 commits into from

Conversation

djs0109
Copy link
Collaborator

@djs0109 djs0109 commented Nov 17, 2023

close #106

@djs0109 djs0109 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 17, 2023
@djs0109 djs0109 linked an issue Nov 17, 2023 that may be closed by this pull request
@Ganesh-eon Ganesh-eon assigned djs0109 and unassigned djs0109 Dec 4, 2023
@djs0109 djs0109 requested review from Ganesh-eon and iripiri and removed request for Ganesh-eon December 4, 2023 15:34
- You can login to the Entirety tool with you Entirety username and password.
- Based on your access rights , you can login as an `admin` or a `project_admin` or a `user`.

1. Admin : Admin has all the admin rights like adding of projects , assigning owners to a project and adding/removing user.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Proposal: link to page/table, where all the user roles and their access rights are listed. "Admin has all the admin rights like .." is not clear enough, are all access rights listed here or not?.
The list of roles and access rights is also not up-to-date already (viewer role) and it would be best if there was only one place where this is documented.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We dont have such a table for overview. But I add a descriptioin about the viewer


## *PROJECTS*

Entirety uses the concept of projects to separate the database into independent data spaces. Each project is bound to specific "fiware-service" headers, following FIWARE's approach to multi-tenancy. This ensures that projects can only access and manipulate data that they created and are authorized for.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add link to "FIWARE's multi-tenancy approach" or leave this part of the sentence out? The concept of separating the data is understandable from the description, but not every user will be acquainted to FIWARE's approach to multi-tenancy.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added


![Alt text](images/image-14.png)

TODO
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Open TODO

@@ -0,0 +1,31 @@
# *NOTIFICATIONS MODULE*

ToDo: The description bellow is not correct
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Someone should correct it then :D

@djs0109 djs0109 requested a review from iripiri May 15, 2024 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation
3 participants