diff --git a/docs/assets/permission/disabled-unregister-entity.png b/docs/assets/permissions/disabled-unregister-entity.png similarity index 100% rename from docs/assets/permission/disabled-unregister-entity.png rename to docs/assets/permissions/disabled-unregister-entity.png diff --git a/docs/assets/permission/permission-framework-overview.drawio.svg b/docs/assets/permissions/permission-framework-overview.drawio.svg similarity index 100% rename from docs/assets/permission/permission-framework-overview.drawio.svg rename to docs/assets/permissions/permission-framework-overview.drawio.svg diff --git a/docs/assets/permission/permission-todo-list-page.png b/docs/assets/permissions/permission-todo-list-page.png similarity index 100% rename from docs/assets/permission/permission-todo-list-page.png rename to docs/assets/permissions/permission-todo-list-page.png diff --git a/docs/permission/concepts.md b/docs/permissions/concepts.md similarity index 100% rename from docs/permission/concepts.md rename to docs/permissions/concepts.md diff --git a/docs/permission/custom-rules.md b/docs/permissions/custom-rules.md similarity index 100% rename from docs/permission/custom-rules.md rename to docs/permissions/custom-rules.md diff --git a/docs/permission/getting-started.md b/docs/permissions/getting-started.md similarity index 99% rename from docs/permission/getting-started.md rename to docs/permissions/getting-started.md index b115b674d6..6daf448cdd 100644 --- a/docs/permission/getting-started.md +++ b/docs/permissions/getting-started.md @@ -152,6 +152,6 @@ permission: 3. Now that you’ve made this change, you should find that the unregister entity menu option on the catalog entity page is disabled. -![Entity detail page showing disabled unregister entity context menu entry](../assets/permission/disabled-unregister-entity.png) +![Entity detail page showing disabled unregister entity context menu entry](../assets/permissions/disabled-unregister-entity.png) Now that the framework is fully configured, you can craft a permission policy that works best for your organization by utilizing a provided authorization method or by [writing your own policy](./writing-a-policy.md)! diff --git a/docs/permission/overview.md b/docs/permissions/overview.md similarity index 97% rename from docs/permission/overview.md rename to docs/permissions/overview.md index 8e87756faa..b972814aeb 100644 --- a/docs/permission/overview.md +++ b/docs/permissions/overview.md @@ -22,7 +22,7 @@ The permission framework was designed with a few key properties in mind: - **Integrators** can author or configure policies that define which users can take certain actions upon which resources. -![](../assets/permission/permission-framework-overview.drawio.svg) +![](../assets/permissions/permission-framework-overview.drawio.svg) 1. The user triggers a request to perform some action. The request specifies the authorization details using the permission specified by the plugin (in this case, a resource read action). diff --git a/docs/permission/plugin-authors/01-setup.md b/docs/permissions/plugin-authors/01-setup.md similarity index 98% rename from docs/permission/plugin-authors/01-setup.md rename to docs/permissions/plugin-authors/01-setup.md index 2f070f603b..d08d1ee79c 100644 --- a/docs/permission/plugin-authors/01-setup.md +++ b/docs/permissions/plugin-authors/01-setup.md @@ -105,7 +105,7 @@ The source code is available here: Now if you start your application you should be able to reach the `/todo-list` page: -![Todo List plugin page](../../assets/permission/permission-todo-list-page.png) +![Todo List plugin page](../../assets/permissions/permission-todo-list-page.png) --- diff --git a/docs/permission/plugin-authors/02-adding-a-basic-permission-check.md b/docs/permissions/plugin-authors/02-adding-a-basic-permission-check.md similarity index 100% rename from docs/permission/plugin-authors/02-adding-a-basic-permission-check.md rename to docs/permissions/plugin-authors/02-adding-a-basic-permission-check.md diff --git a/docs/permission/plugin-authors/03-adding-a-resource-permission-check.md b/docs/permissions/plugin-authors/03-adding-a-resource-permission-check.md similarity index 100% rename from docs/permission/plugin-authors/03-adding-a-resource-permission-check.md rename to docs/permissions/plugin-authors/03-adding-a-resource-permission-check.md diff --git a/docs/permission/plugin-authors/04-authorizing-access-to-paginated-data.md b/docs/permissions/plugin-authors/04-authorizing-access-to-paginated-data.md similarity index 100% rename from docs/permission/plugin-authors/04-authorizing-access-to-paginated-data.md rename to docs/permissions/plugin-authors/04-authorizing-access-to-paginated-data.md diff --git a/docs/permission/writing-a-policy.md b/docs/permissions/writing-a-policy.md similarity index 100% rename from docs/permission/writing-a-policy.md rename to docs/permissions/writing-a-policy.md diff --git a/microsite/sidebars.json b/microsite/sidebars.json index a8dc4e53ee..7bbe67f58f 100644 --- a/microsite/sidebars.json +++ b/microsite/sidebars.json @@ -259,19 +259,19 @@ "auth/glossary" ], "Permissions": [ - "permission/overview", - "permission/concepts", - "permission/getting-started", - "permission/writing-a-policy", - "permission/custom-rules", + "permissions/overview", + "permissions/concepts", + "permissions/getting-started", + "permissions/writing-a-policy", + "permissions/custom-rules", { "type": "subcategory", "label": "Tutorial: using Permissions in your plugin", "ids": [ - "permission/plugin-authors/01-setup", - "permission/plugin-authors/02-adding-a-basic-permission-check", - "permission/plugin-authors/03-adding-a-resource-permission-check", - "permission/plugin-authors/04-authorizing-access-to-paginated-data" + "permissions/plugin-authors/01-setup", + "permissions/plugin-authors/02-adding-a-basic-permission-check", + "permissions/plugin-authors/03-adding-a-resource-permission-check", + "permissions/plugin-authors/04-authorizing-access-to-paginated-data" ] } ], diff --git a/plugins/example-todo-list-backend/README.md b/plugins/example-todo-list-backend/README.md index d5c51b2b57..f1dbd427d2 100644 --- a/plugins/example-todo-list-backend/README.md +++ b/plugins/example-todo-list-backend/README.md @@ -1,3 +1,3 @@ # todo-list-backend -This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permission/plugin-authors/01-setup) to get started. +This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permissions/plugin-authors/01-setup) to get started. diff --git a/plugins/example-todo-list-common/README.md b/plugins/example-todo-list-common/README.md index 021eca1033..4962d61bd0 100644 --- a/plugins/example-todo-list-common/README.md +++ b/plugins/example-todo-list-common/README.md @@ -1,3 +1,3 @@ # todo-list-common -This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permission/plugin-authors/01-setup) to get started. +This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permissions/plugin-authors/01-setup) to get started. diff --git a/plugins/example-todo-list/README.md b/plugins/example-todo-list/README.md index bd77af87e8..8d5daab89b 100644 --- a/plugins/example-todo-list/README.md +++ b/plugins/example-todo-list/README.md @@ -1,3 +1,3 @@ # todo-list -This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permission/plugin-authors/01-setup) to get started. +This package provides a starting point to demonstrate how plugin authors can use the Backstage permission framework. Refer to the [documentation](https://backstage.io/docs/permissions/plugin-authors/01-setup) to get started.