[pbs-devel] [PATCH proxmox-backup] docs: user management: avoid some inconsistencies

[pbs-devel] [PATCH proxmox-backup] docs: user management: avoid some inconsistencies

[Fabian Ebner]

The space between '--' and 'path' in two of the commands was wrong. The other
changes make the names of the store and token consistent with the rest of the
section and should improve readability.

Also add the Datastore.Verify permission in the output of the command:
proxmox-backup-manager user permissions john@pbs --path /datastore/store1
A DatastoreAdmin now has this permission and that's what john@pbs is in the
example.

Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
---
 docs/user-management.rst | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/docs/user-management.rst b/docs/user-management.rst
index 06348917..fc849dde 100644
--- a/docs/user-management.rst
+++ b/docs/user-management.rst
@@ -230,11 +230,11 @@ You can list the ACLs of each user/token using the following command:
 .. code-block:: console
 
    # proxmox-backup-manager acl list
-   ┌──────────┬──────────────────┬───────────┬────────────────┐
-   │ ugid     │ path             │ propagate │ roleid         │
-   ╞══════════╪══════════════════╪═══════════╪════════════════╡
-   │ john@pbs │ /datastore/disk1 │         1 │ DatastoreAdmin │
-   └──────────┴──────────────────┴───────────┴────────────────┘
+   ┌──────────┬───────────────────┬───────────┬────────────────┐
+   │ ugid     │ path              │ propagate │ roleid         │
+   ╞══════════╪═══════════════════╪═══════════╪════════════════╡
+   │ john@pbs │ /datastore/store1 │         1 │ DatastoreAdmin │
+   └──────────┴───────────────────┴───────────┴────────────────┘
 
 A single user/token can be assigned multiple permission sets for different datastores.
 
@@ -267,7 +267,7 @@ you can use the ``proxmox-backup-manager user permission`` command:
 
 .. code-block:: console
 
-  # proxmox-backup-manager user permissions john@pbs -- path /datastore/store1
+  # proxmox-backup-manager user permissions john@pbs --path /datastore/store1
   Privileges with (*) have the propagate flag set
   
   Path: /datastore/store1
@@ -276,9 +276,10 @@ you can use the ``proxmox-backup-manager user permission`` command:
   - Datastore.Modify (*)
   - Datastore.Prune (*)
   - Datastore.Read (*)
+  - Datastore.Verify (*)
   
   # proxmox-backup-manager acl update /datastore/store1 DatastoreBackup --auth-id 'john@pbs!client1'
-  # proxmox-backup-manager user permissions 'john@pbs!test' -- path /datastore/store1
+  # proxmox-backup-manager user permissions 'john@pbs!client1' --path /datastore/store1
   Privileges with (*) have the propagate flag set
   
   Path: /datastore/store1
-- 
2.20.1

[pbs-devel] applied: [PATCH proxmox-backup] docs: user management: avoid some inconsistencies

[Thomas Lamprecht]

On 10.11.20 13:33, Fabian Ebner wrote:
> The space between '--' and 'path' in two of the commands was wrong. The other
> changes make the names of the store and token consistent with the rest of the
> section and should improve readability.
> 
> Also add the Datastore.Verify permission in the output of the command:
> proxmox-backup-manager user permissions john@pbs --path /datastore/store1
> A DatastoreAdmin now has this permission and that's what john@pbs is in the
> example.
> 
> Signed-off-by: Fabian Ebner <f.ebner@proxmox.com>
> ---
>  docs/user-management.rst | 15 ++++++++-------
>  1 file changed, 8 insertions(+), 7 deletions(-)
> 
>

applied, thanks!