Patrik Oldsberg
41836147fc
Migrated entity filters from deprecated string-based format to the new
entity predicate format in the alpha exports. Also updated documentation
across multiple plugins to use the new format and Blueprint APIs.
Changes:
- Migrated all entity filters in api-docs plugin from strings like
'kind:api' to entity predicates like { kind: 'api' }
- Updated documentation examples in api-docs, org, kubernetes, and
catalog-graph plugins
- Migrated all documentation examples from createEntityCardExtension and
createEntityContentExtension to use EntityCardBlueprint and
EntityContentBlueprint
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Org Plugin for Backstage
Disclaimer: If you are looking for documentation on the experimental new frontend system support, please go here.
Features
- Show Group Page
- Show User Profile
- Quick access to Groups
Group Page
Here's an example of what the Group Page looks like:
User Profile
Here's an example of what the User Profile looks like:
MyGroupsSidebarItem
The MyGroupsSidebarItem provides quick access to the group(s) the logged in user is a member of directly in the sidebar.
To use the MyGroupsSidebarItem you'll need to add it to your Root.tsx - found at packages\app\src\components\Root - like this:
+ import { MyGroupsSidebarItem } from '@backstage/plugin-org';
+ import GroupIcon from '@material-ui/icons/People';
<SidebarPage>
<Sidebar>
//...
<SidebarGroup label="Menu" icon={<MenuIcon />}>
{/* Global nav, not org-specific */}
//...
<SidebarItem icon={HomeIcon} to="catalog" text="Home" />
+ <MyGroupsSidebarItem
+ singularTitle="My Squad"
+ pluralTitle="My Squads"
+ icon={GroupIcon}
+ />
//...
</SidebarGroup>
</ Sidebar>
</SidebarPage>
Once added MyGroupsSidebarItem will work in three ways:
-
The user is not logged in or the logged in user is not a member of any group: the MyGroupsSidebarItem will not display anything in the sidebar
-
The user is logged in and a member of only one group: the MyGroupsSidebarItem will display a single item in the sidebar like this:
-
The user is logged in and a member of more than one group: the MyGroupsSidebarItem will display a single items with a sub-menu with all the related groups like this:
