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

Revise Viewing the Catalog documentation

Browse Source 
Updated content and images for the Viewing the Catalog documentation.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
This commit is contained in:
milliehartnt123
2025-11-19 13:54:20 -05:00
committed by GitHub
parent 826fef5d8f
commit 49d2e017ba
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/viewing-catalog.md
+9 -3
View File
@@ -11,7 +11,7 @@ Audience: Developers
When you first log into your standalone Backstage App, `Home` is selected in the sidebar, which displays the Catalog in the main panel.
![Screenshot explaining entity actions.](../assets/uiguide/entity-actions.png)
![Portal with annotations.](../assets/uiguide/portal-with-annotations.png)
The [Techical Overview](../overview/technical-overview.md) provides greater detail, but the catalog displays two main kinds of registered entities:
@@ -110,12 +110,18 @@ A page is displayed that shows the entities of which you have owenership, either
## Viewing entitiy relationships
Each of the entities in the Catalog have various relationships to each other. For example, the demo data includes an API that provides data to a website. `guests` is the owner of the API and the website, and anyone signed in as part of the `guests` group can maintain them. To see these relationships, select the name of the component in the main panel, in this example, **example-website**.
Each of the entities in the Catalog have various relationships to each other. For example, the demo data includes an API that provides data to a website. `guests` is the owner of the API and the website, and anyone signed in as part of the `guests` group can maintain them.
To see these relationships:
1. select the name of the component in the main panel, in this example, **example-website**.
![Screenshot of the Backstage portal with example-website selected.](../assets/uiguide/select-example-website.png)
![Screenshot of the Backstage portal with example-website selected.](../assets/uiguide/select-example-website.png)
A page is displayed that includes a **Relations** section. This section displays the selected entity and any other types of entities to which it is related. Each relationship is also designated, such as `hasPart/partOf` and `apiProvidedBy/providesApi`. [Well-known Relations between Catalog Entities](../features/software-catalog/well-known-relations.md) describes the most common relationships but you can also [create your own relationships](../features/software-catalog/extending-the-model.md#adding-a-new-relation-type).
Selecting any of the related entities allows you to drill down further through the system model.
![Screenshot of the example-website Relations panel.](../assets/uiguide/example-website-relationships.png)