paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

README: update create plugin docs

Browse Source
This commit is contained in:
Patrik Oldsberg
2020-03-05 11:57:54 +01:00
parent 363739f2e9
commit e3f2b62212
1 changed files with 2 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+2 -20
View File
@@ -66,27 +66,9 @@ To create a new plugin, go to the `frontend/` directory and run the following:
$ yarn && yarn create-plugin
```
This will prompt you to enter an ID for your plugin, and then create your plugin inside the `packages/plugins/` directory. Note that the plugin will not yet be included in the app, to include it add the following for a plugin called `my-plugin`:
This will prompt you to enter an ID for your plugin, and then create your plugin inside the `packages/plugins/` directory. The plugin will be automatically included in the app by modifing the app's `package.json` and `src/plugins.ts`.
In `"dependencies"` inside [packages/app/package.json](frontend/packages/app/package.json) add the following:
```json
"@spotify-backstage/plugin-my-plugin": "0.0.0"
```
In [packages/app/src/plugins.ts](frontend/packages/app/src/plugins.ts), add the following:
```
export { default as MyPlugin } from '@spotify-backstage/plugin-my-plugin';
```
To apply the above changes, go to the `frontend/` directory and run:
```
$ yarn
```
Now start or restart `yarn start`, and you should be able to see the default page for your new plugin at [localhost:3000/my-plugin](http://localhost:3000/my-plugin).
If you have `yarn start` already running you should be able to see the default page for your new plugin at [localhost:3000/my-plugin](http://localhost:3000/my-plugin), if you called the plugin `"my-plugin"`.
## Documentation