diff --git a/docs/permission/adopters/index.md b/docs/permission/adopters/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/permission/concepts.md b/docs/permission/concepts.md new file mode 100644 index 0000000000..d9b49a3c63 --- /dev/null +++ b/docs/permission/concepts.md @@ -0,0 +1,5 @@ +--- +id: concepts +title: Permission Framework Concepts +description: A list of important permission framework concepts +--- diff --git a/docs/permission/getting-started.md b/docs/permission/getting-started.md new file mode 100644 index 0000000000..e0138171b6 --- /dev/null +++ b/docs/permission/getting-started.md @@ -0,0 +1,5 @@ +--- +id: getting-started +title: Getting Started +description: How to get started with the permission framework as an integrator +--- diff --git a/docs/permission/overview.md b/docs/permission/overview.md index 808a93119e..7b1c25669e 100644 --- a/docs/permission/overview.md +++ b/docs/permission/overview.md @@ -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. diff --git a/docs/permission/plugin-authors/index.md b/docs/permission/plugin-authors/index.md deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/docs/permission/writing-a-policy.md b/docs/permission/writing-a-policy.md new file mode 100644 index 0000000000..aa66e92e58 --- /dev/null +++ b/docs/permission/writing-a-policy.md @@ -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 +--- diff --git a/docs/plugins/permissions/index.md b/docs/plugins/permissions/index.md new file mode 100644 index 0000000000..56ec077895 --- /dev/null +++ b/docs/plugins/permissions/index.md @@ -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. +--- diff --git a/microsite/sidebars.json b/microsite/sidebars.json index c6643eca5d..9553b4b566 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -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",