From c185466d8c7275cbc75a45bb38cd21fc3a1dd96c Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Mon, 13 Mar 2023 17:52:09 +0100
Subject: [PATCH] DOC: Fixed misleading permission documentation (#193).
---
CHANGELOG.md | 1 +
src/doc/permissions.rst | 8 ++++----
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index cc5e5b64..b10d028f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Documentation ###
- Nested queries.
+- Global entity permissions.
## [0.9.0] - 2023-01-19
diff --git a/src/doc/permissions.rst b/src/doc/permissions.rst
index 6b07f48f..3d9c5ed7 100644
--- a/src/doc/permissions.rst
+++ b/src/doc/permissions.rst
@@ -124,8 +124,8 @@ How to set permissions
----------------------
There are multiple ways to set role and entity permissions. The most
-common and best tested way currently is to set global default entity permissions
-in the ``global_entity_permissions.xml`` config file, and role-based role
+common and best tested way currently is to set global default *entity* permissions
+in the ``global_entity_permissions.xml`` config file, and role-based *role*
permissions with the ``caosdb_admin.py`` `utility script
<https://gitlab.com/caosdb/caosdb-pylib/-/blob/main/src/caosdb/utils/caosdb_admin.py>`__
of CaosDB's Python library which is also used to `manage users and
@@ -138,8 +138,8 @@ find a more detailed description of the possible ways of setting permissions.
you can set the default permissions that every entity on the server has. The
global default permissions can **only** be set in this file; all other ways
below can only change the permissions of individual entities. Note that you
- can add more rules but you can never remove rules set in the
- ``global_entity_permissions.xml``. Thus, it might not be possible to overrule
+ can add more rules in the ``global_entity_permissions.xml``, but you can not remove rules by
+ writing to this file. Thus, it might not be possible to overrule
permissions defined here (see :ref:`Permission
calculation<Calculation>`). Note also that, as the name suggests, only
:ref:`entity permissions<entity-permissions>` can be set this way. The
--
GitLab