Updating the Backstage UI

Published on August 6th, 2021

Introduction

Roadie allows you to configure which plugins you want to use via our UI. This guide explains the different types of plugin components and the different places they can be integrated into the app.

Prerequisites

You must be an admin to edit the UI layout. Please complete this guide before moving on to this one.

About Plugins

Backstage is a plugin based application where each plugin provides a certain piece of functionality. A plugin may integrate with some external system such as GitHub to display information for a certain Entity e.g. Show pull request information for a particular service.

You can read more about Backstage plugins here.

Backstage plugins can provide three different types of UI elements:

  1. Card - These are tiles which can be arranged into dashboards in the software catalog. E.g. The About card.
  2. Content - These are tabs which can be integrated with the catalog. E.g. The TechDocs tab.
  3. Page - These are top-level pages in Backstage, outside of the catalog. Accessible via links in the sidebar. E.g. The catalog itself is a Page.

Updating the Catalog Layout

Admin users can add components to catalog pages to configure what is displayed to users when they view an entity. Layouts are configured per entity kind except for Component entities which have layouts per type. For example, “User” and “Group” are each kinds of entity and so User entities have a different layout to Group entities. Similarly, Component entities have types such as “Service”, “Library”, “Website”, etc and different types can have different layouts. However, a particular entity can’t have its own layout; A particular Group or service can’t have a unique layout. This is to encourage a consistent UX.

Updating Tabs

To add a tab click the plus icon at the end of the tab list.

Add tab button

Then select the component to add via the autocomplete and give the tab a display name and click “Create”.

Add tab dialog

To rearrange or delete tabs select the “pencil” edit icon on the far right of the tab bar.

Edit tab layout

Then drag and drop to rearrange or click the “x” icon to remove a tab then click the save icon on the right hand side.

Move tab

Updating Dashboards

To edit a dashboard click the cog icon on the top right of the dashboard below the tab bar.

Edit Dashboard Button

This will switch the dashboard into an edit view. You can drag and drop to rearrange or click the dustbin icon to remove a card.

Edit dashboard view

To add a card click the plus icon in the menu on the top right of the dashboard.

Add card button

Then select the card to add and click “Add”.

Add card dialog

You can adjust the position of the new card as above. When you’re finished don’t forget to save your changes!

Save layout button

Entities will have one “Overview” dashboard by default but you can add others. Simply create a tab selecting “Dashboard” as the component to add.

Add a dashboard

Updating the Sidebar

Page components are displayed in the sidebar. To edit the sidebar click the “Edit Sidebar” icon.

Edit sidebar button

You can then drag and drop to rearrange or click the “x” icon to delete.

Edit Sidebar

To add a page click the “Add Page” icon.

Add page button

Then select the component in the autocomplete and adjust the title and path as necessary and click “Add”.

Add page screen

Finally, don’t forget to save your changes.

Save sidebar