hazza/jupyterhub
1
0
Fork 0
mirror of https://github.com/jupyterhub/jupyterhub.git synced 2025-10-13 13:03:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adjusted documentation for auth pages

Browse Source
This commit is contained in:
0mar
2021-06-11 13:32:20 +02:00
parent 03e2e7f3b0
commit 8864780bfb
2 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/rbac/generate-scope-table.py
View File

@@ -61,9 +61,9 @@ class ScopeTableGenerator:
def _add_subscopes(table_rows, scopename, depth=0): def _add_subscopes(table_rows, scopename, depth=0):
description = self.scopes[scopename]['description'] description = self.scopes[scopename]['description']
meta_description = self.scopes[scopename].get('metadescription', '') doc_description = self.scopes[scopename].get('doc_description', '')
if meta_description: if doc_description:
description = description.rstrip('.') + f" _({meta_description})_." description = doc_description
table_row = [f"{md_indent*depth}`{scopename}`", description] table_row = [f"{md_indent*depth}`{scopename}`", description]
table_rows.append(table_row) table_rows.append(table_row)
for subscope in scope_pairs[scopename]: for subscope in scope_pairs[scopename]:

16
jupyterhub/scopes.py
View File

@@ -25,12 +25,12 @@ from . import roles
scope_definitions = { scope_definitions = {
'(no_scope)': {'description': 'Identify the owner of this entity.'}, '(no_scope)': {'description': 'Identify the owner of this entity.'},
'self': { 'self': {
'description': 'The user’s own resources.', 'description': 'Your own resources',
'metadescription': 'metascope for users, resolves to (no_scope) for services', 'doc_description': 'The user’s own resources _(metascope for users, resolves to (no_scope) for services)_',
}, },
'all': { 'all': {
'description': 'Everything that the token-owning entity can access.', 'description': 'Anything you have access to',
'metadescription': 'metascope for tokens', 'doc_description': 'Everything that the token-owning entity can access _(metascope for tokens)_',
}, },
'admin:users': { 'admin:users': {
'description': 'Read, write, create and delete users and their authentication state, not including their servers or tokens.', '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: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: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': { 'users:activity': {
'description': 'Update time of last user activity.', 'description': 'Update time of last user activity.',
'subscopes': ['read:users:activity'], 'subscopes': ['read:users:activity'],
@@ -88,13 +88,13 @@ scope_definitions = {
'subscopes': ['read:groups:name'], 'subscopes': ['read:groups:name'],
}, },
'read:groups:name': {'description': 'Read group names.'}, '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': { 'read:services': {
'description': 'Read service models.', 'description': 'Read service models.',
'subscopes': ['read:services:name'], 'subscopes': ['read:services:name'],
}, },
'read:services:name': {'description': 'Read service names.'}, '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.'}, 'read:hub': {'description': 'Read detailed information about the Hub.'},
'access:users:servers': { 'access:users:servers': {
'description': 'Access user servers via API or browser.', 'description': 'Access user servers via API or browser.',