Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dynamic-plugins): update todo plugin instructions and add TypeScript compilation step #2182

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 18 additions & 17 deletions docs/dynamic-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,15 @@ Example of this process on the [todo](https://github.com/backstage/community-plu
$ git clone https://github.com/backstage/community-plugins
$ cd community-plugins/workspaces/todo
$ yarn install
$ yarn tsc
```

2. Export the backend and frontend plugins

Export backend plugin.

```console
$ cd todo-backend
$ cd plugins/todo-backend
$ npx @janus-idp/cli@latest package export-dynamic-plugin
Building main package
executing yarn build ✔
Expand Down Expand Up @@ -148,22 +149,22 @@ Example of this process on the [todo](https://github.com/backstage/community-plu
Add plugins defintion to the `dynamic-plugins.yaml` file.

```yaml
# dynamic-plugins.yaml
packages:
- package: oci://quay.io/tkral/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo
pluginConfig:
dynamicPlugins:
frontend:
backstage-community.plugin-todo:
mountPoints:
- mountPoint: entity.page.todo/cards
importName: EntityTodoContent
entityTabs:
- path: /todo
title: Todo
mountPoint: entity.page.todo
- package: oci://quay.io/tkral/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo-backend-dynamic
disabled: false
# frontend and backend plugins for the todo plugin
- package: oci://quay.io/user/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo
disabled: false
pluginConfig:
dynamicPlugins:
frontend:
backstage-community.plugin-todo:
mountPoints:
- mountPoint: entity.page.todo/cards
importName: EntityTodoContent
entityTabs:
- path: /todo
title: Todo
mountPoint: entity.page.todo
- package: oci://quay.io/user/backstage-community-plugin-todo:v0.1.1!backstage-community-plugin-todo-backend-dynamic
disabled: false
```


Expand Down
Loading