Updated Playlist docs
Signed-off-by: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
This commit is contained in:
@@ -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
|
||||
@@ -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';
|
||||
|
||||
@@ -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 Playlist
|
||||
|
||||

|
||||
|
||||
### Create New Playlist
|
||||
|
||||

|
||||
|
||||
### Add Entities to Playlist
|
||||
|
||||

|
||||
|
||||
### Add to Playlist from Entity
|
||||
|
||||

|
||||
|
||||
## Links
|
||||
|
||||
- [playlist-backend](../playlist-backend) provides the backend API for this frontend.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 222 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 190 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 203 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 140 KiB |
@@ -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",
|
||||
|
||||
Reference in New Issue
Block a user