diff --git a/docs/assets/permission/permission-tutorial-backstage-application-initial-structure.png b/docs/assets/permission/permission-tutorial-backstage-application-initial-structure.png deleted file mode 100644 index f7e18960ec..0000000000 Binary files a/docs/assets/permission/permission-tutorial-backstage-application-initial-structure.png and /dev/null differ diff --git a/docs/permission/plugin-authors/01-setup.md b/docs/permission/plugin-authors/01-setup.md index 981a6ee6ab..ee90875fd0 100644 --- a/docs/permission/plugin-authors/01-setup.md +++ b/docs/permission/plugin-authors/01-setup.md @@ -28,13 +28,9 @@ The source code is available here: backstage-master/contrib/plugins/todo-list-common ``` - Your application structure should look something like this: + The `plugins` directory of your project should now include `todo-list`, `todo-list-backend`, and `todo-list-common`. - // TODO: UPDATE THIS IMAGE - - ![backstage application files structure](../../assets/permission/permission-tutorial-backstage-application-initial-structure.png) - -2. Add the frontend and backend plugins as dependencies of your Backstage app and backend respectively: +2. Add these packages as dependencies for your Backstage app: ``` $ yarn workspace backend add @internal/plugin-todo-list-backend@^1.0.0 @internal/plugin-todo-list-common@^1.0.0 diff --git a/docs/permission/plugin-authors/02-adding-a-basic-permission-check.md b/docs/permission/plugin-authors/02-adding-a-basic-permission-check.md index 55dd3e85ab..f944b9ecc5 100644 --- a/docs/permission/plugin-authors/02-adding-a-basic-permission-check.md +++ b/docs/permission/plugin-authors/02-adding-a-basic-permission-check.md @@ -26,7 +26,7 @@ Let's navigate to the file `plugins/todo-list-common/src/permissions.ts` and add }); ``` -For this tutorial, we've automatically exported all permissions from this file (see `plugins/todo-list-common/src/index.ts`). For the actual plugins that you author, we recommend exporting all permissions from your plugin, so that Backstage integrators can import them when writing policies. +For this tutorial, we've automatically exported all permissions from this file (see `plugins/todo-list-common/src/index.ts`). For the actual plugins that you author, you must export any permission authorized by the plugin so Backstage integrators can import them when writing policies. ## Authorizing using the new permission diff --git a/docs/permission/plugin-authors/03-adding-a-resource-permission-check.md b/docs/permission/plugin-authors/03-adding-a-resource-permission-check.md index 583d7e7707..a61c74219b 100644 --- a/docs/permission/plugin-authors/03-adding-a-resource-permission-check.md +++ b/docs/permission/plugin-authors/03-adding-a-resource-permission-check.md @@ -154,7 +154,7 @@ Now, let's create the new endpoint by editing `plugins/todo-list-backend/src/ser ## Test the authorized update endpoint -Now let's go back to the permission policy's handle function (which would normally be written by your integrators) and try to authorize our new permission. +Now let's go back to the permission policy's handle function and try to authorize our new permission. Let's edit `packages/backend/src/plugins/permission.ts`: