diff --git a/.changeset/lucky-cobras-sell.md b/.changeset/lucky-cobras-sell.md new file mode 100644 index 0000000000..16d86d52e8 --- /dev/null +++ b/.changeset/lucky-cobras-sell.md @@ -0,0 +1,9 @@ +--- +'@backstage/plugin-playlist': patch +'@backstage/plugin-playlist-backend': patch +--- + +Updated Playlist plugin docs: + +- Updated `playlist` plugin README to include note about installing backend plugin and added images for the various features +- Updated `playlist-backend` plugin README to remove `IdentityClient` import in example as it is not used and made minor change to headings diff --git a/plugins/playlist-backend/README.md b/plugins/playlist-backend/README.md index 14a39ca741..c0055ebdf7 100644 --- a/plugins/playlist-backend/README.md +++ b/plugins/playlist-backend/README.md @@ -2,21 +2,20 @@ Welcome to the playlist backend plugin! -# Installation +## Installation -## Install the package +### Install the package ```bash # From your Backstage root directory yarn add --cwd packages/backend @backstage/plugin-playlist-backend ``` -## Adding the plugin to your `packages/backend` +### Adding the plugin to your `packages/backend` You'll need to add the plugin to the router in your `backend` package. You can do this by creating a file called `packages/backend/src/plugins/playlist.ts` ```tsx -import { IdentityClient } from '@backstage/plugin-auth-node'; import { createRouter } from '@backstage/plugin-playlist-backend'; import { Router } from 'express'; import { PluginEnvironment } from '../types'; diff --git a/plugins/playlist/README.md b/plugins/playlist/README.md index 7c814d302b..6ae3fb84ac 100644 --- a/plugins/playlist/README.md +++ b/plugins/playlist/README.md @@ -6,6 +6,14 @@ This plugin allows you to create, share, and follow custom collections of entiti ## Setup +The following sections will help you get the Playlist plugin setup and running + +### Backend + +You need to setup the [Playlist backend plugin](https://github.com/backstage/backstage/tree/master/plugins/playlist-backend) before you move forward with any of these steps if you haven't already + +### Installation + Install this plugin: ```bash @@ -123,6 +131,28 @@ const defaultEntityPage = ( Note: the above only shows an example for the `defaultEntityPage` for a full example of this you can look at [this EntityPage](../../packages/app/src/components/catalog/EntityPage.tsx) +## Features + +### View All Playlists + +![View all playlists example](./docs/playlist-view-all.png) + +### View Playlist + +![View Playlist example](./docs/playlist-view-single.png) + +### Create New Playlist + +![Create New Playlist example](./docs/playlist-create-new.png) + +### Add Entities to Playlist + +![Add Entities to Playlist example](./docs/playlist-add-entities.png) + +### Add to Playlist from Entity + +![Add to Playlist from Entity example](./docs/playlist-add-from-entity.png) + ## Links - [playlist-backend](../playlist-backend) provides the backend API for this frontend. diff --git a/plugins/playlist/docs/playlist-add-entities.png b/plugins/playlist/docs/playlist-add-entities.png new file mode 100644 index 0000000000..a53de49880 Binary files /dev/null and b/plugins/playlist/docs/playlist-add-entities.png differ diff --git a/plugins/playlist/docs/playlist-add-from-entity.png b/plugins/playlist/docs/playlist-add-from-entity.png new file mode 100644 index 0000000000..d41135064a Binary files /dev/null and b/plugins/playlist/docs/playlist-add-from-entity.png differ diff --git a/plugins/playlist/docs/playlist-create-new.png b/plugins/playlist/docs/playlist-create-new.png new file mode 100644 index 0000000000..cc369e26fa Binary files /dev/null and b/plugins/playlist/docs/playlist-create-new.png differ diff --git a/plugins/playlist/docs/playlist-view-all.png b/plugins/playlist/docs/playlist-view-all.png new file mode 100644 index 0000000000..1b65eb1af2 Binary files /dev/null and b/plugins/playlist/docs/playlist-view-all.png differ diff --git a/plugins/playlist/docs/playlist-view-single.png b/plugins/playlist/docs/playlist-view-single.png new file mode 100644 index 0000000000..0890c5013b Binary files /dev/null and b/plugins/playlist/docs/playlist-view-single.png differ diff --git a/plugins/playlist/package.json b/plugins/playlist/package.json index df620fc97a..84e61dc718 100644 --- a/plugins/playlist/package.json +++ b/plugins/playlist/package.json @@ -12,6 +12,11 @@ "backstage": { "role": "frontend-plugin" }, + "repository": { + "type": "git", + "url": "https://github.com/backstage/backstage", + "directory": "plugins/playlist" + }, "scripts": { "start": "backstage-cli package start", "build": "backstage-cli package build",