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

Merge pull request #33113 from backstage/rugvip/docs-frontend-plugin-installation

Browse Source 
docs: default frontend plugin docs to the new frontend system
This commit is contained in:
Patrik Oldsberg
2026-03-16 22:08:47 +01:00
committed by GitHub
parent 22f101e208 1decc6f994
commit 55b18a3c2e
22 changed files with 722 additions and 614 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/org/README-alpha.md
+2 -4
View File
@@ -1,8 +1,6 @@
# Org Plugin
# Org Plugin - Extension Reference
> [!WARNING]
> This documentation is made for those using the experimental new Frontend system.
> If you are not using the new frontend system, please go [here](./README.md).
This page contains detailed documentation for all extensions provided by the `@backstage/plugin-org` plugin. For general information about the plugin, see the [README](./README.md).
This is a plugin that extends the Catalog entity page with some users and groups overview cards:
plugins/org/README.md
+27 -3
View File
@@ -1,8 +1,5 @@
# Org Plugin for Backstage
> Disclaimer:
> If you are looking for documentation on the experimental new frontend system support, please go [here](./README-alpha.md).
## Features
- Show Group Page
@@ -21,6 +18,33 @@ Here's an example of what the User Profile looks like:
![Group Page example](./docs/user-profile-example.png)
## Installation
```bash
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-org
```
Once installed, the plugin is automatically available in your app through the default feature discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
You can enable entity cards on the catalog entity page through configuration:
```yaml
# app-config.yaml
app:
extensions:
- entity-card:org/group-profile
- entity-card:org/members-list
- entity-card:org/ownership
- entity-card:org/user-profile
```
For the full list of available extensions and their configuration options, see the [README-alpha.md](./README-alpha.md).
## Old Frontend System
If your Backstage app uses the old frontend system, you need to manually wire the plugin into your app as outlined in this section. If you are on the new frontend system, you can skip this.
### MyGroupsSidebarItem
The MyGroupsSidebarItem provides quick access to the group(s) the logged in user is a member of directly in the sidebar.