diff --git a/docs/source/rbac/generate-scope-table.py b/docs/source/rbac/generate-scope-table.py index 7a4d3a4a..99b1ddbb 100644 --- a/docs/source/rbac/generate-scope-table.py +++ b/docs/source/rbac/generate-scope-table.py @@ -61,9 +61,9 @@ class ScopeTableGenerator: def _add_subscopes(table_rows, scopename, depth=0): description = self.scopes[scopename]['description'] - meta_description = self.scopes[scopename].get('metadescription', '') - if meta_description: - description = description.rstrip('.') + f" _({meta_description})_." + doc_description = self.scopes[scopename].get('doc_description', '') + if doc_description: + description = doc_description table_row = [f"{md_indent*depth}`{scopename}`", description] table_rows.append(table_row) for subscope in scope_pairs[scopename]: diff --git a/jupyterhub/scopes.py b/jupyterhub/scopes.py index c7c37577..e47786a6 100644 --- a/jupyterhub/scopes.py +++ b/jupyterhub/scopes.py @@ -25,12 +25,12 @@ from . import roles scope_definitions = { '(no_scope)': {'description': 'Identify the owner of this entity.'}, 'self': { - 'description': 'The user’s own resources.', - 'metadescription': 'metascope for users, resolves to (no_scope) for services', + 'description': 'Your own resources', + 'doc_description': 'The user’s own resources _(metascope for users, resolves to (no_scope) for services)_', }, 'all': { - 'description': 'Everything that the token-owning entity can access.', - 'metadescription': 'metascope for tokens', + 'description': 'Anything you have access to', + 'doc_description': 'Everything that the token-owning entity can access _(metascope for tokens)_', }, 'admin:users': { 'description': 'Read, write, create and delete users and their authentication state, not including their servers or tokens.', @@ -50,9 +50,9 @@ scope_definitions = { ], }, 'read:users:name': {'description': 'Read names of users.'}, - 'read:users:groups': {'description': 'Read names of users’ groups.'}, + 'read:users:groups': {'description': 'Read users’ group membership.'}, 'read:users:activity': {'description': 'Read time of last user activity.'}, - 'read:users:roles': {'description': 'Read names of users’ roles.'}, + 'read:users:roles': {'description': 'Read users’ role assignments.'}, 'users:activity': { 'description': 'Update time of last user activity.', 'subscopes': ['read:users:activity'], @@ -88,13 +88,13 @@ scope_definitions = { 'subscopes': ['read:groups:name'], }, 'read:groups:name': {'description': 'Read group names.'}, - 'read:groups:roles': {'description': 'Read group role names.'}, + 'read:groups:roles': {'description': 'Read group role assignments.'}, 'read:services': { 'description': 'Read service models.', 'subscopes': ['read:services:name'], }, 'read:services:name': {'description': 'Read service names.'}, - 'read:services:roles': {'description': 'Read service role names.'}, + 'read:services:roles': {'description': 'Read service role assignments.'}, 'read:hub': {'description': 'Read detailed information about the Hub.'}, 'access:users:servers': { 'description': 'Access user servers via API or browser.',