Outline permission docs structure (#9485)

Signed-off-by: Joon Park <joonp@spotify.com>
This commit is contained in:
Joon Park
2022-02-11 20:38:29 +01:00
parent be21be4108
commit 8f216f89be
8 changed files with 33 additions and 3 deletions
View File
+5
View File
@@ -0,0 +1,5 @@
---
id: concepts
title: Permission Framework Concepts
description: A list of important permission framework concepts
---
+5
View File
@@ -0,0 +1,5 @@
---
id: getting-started
title: Getting Started
description: How to get started with the permission framework as an integrator
---
+2 -2
View File
@@ -36,6 +36,6 @@ The permission framework was designed with a few key properties in mind:
## How do I get started?
If you are a Backstage integrator, see the permission framework [documentation for adopters](./adopters/index.md).
See the "[getting started](./getting-started.md)" permission documentation for Backstage integrators.
If you are a plugin author, see the permission framework [documentation for plugin authors](./plugin-authors/index.md).
If you are a plugin author, see the permission [documentation for plugin authors](../plugins/permissions/index.md) on how to integrate permissions into your plugin.
+5
View File
@@ -0,0 +1,5 @@
---
id: writing-a-policy
title: Writing a permission policy
description: How to write your own permission policy as a Backstage integrator
---
+5
View File
@@ -0,0 +1,5 @@
---
id: index
title: Integrating Permissions into Plugins
description: Learn how to integrate permissions into a Backstage plugin by following along with this Todo Plugin tutorial.
---
+11 -1
View File
@@ -223,6 +223,11 @@
"plugins/add-to-marketplace",
"plugins/observability"
]
},
{
"type": "subcategory",
"label": "Permissions",
"ids": ["plugins/permissions/index"]
}
],
"Configuration": [
@@ -256,7 +261,12 @@
"auth/auth-backend-classes",
"auth/glossary"
],
"Permissions": ["permission/overview"],
"Permissions": [
"permission/overview",
"permission/getting-started",
"permission/writing-a-policy",
"permission/concepts"
],
"Deployment": [
"deployment/index",
"deployment/docker",