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

Improve documentation on entity relationships and filters

Browse Source 
Updated formatting and clarified steps for viewing entity relationships and filtering in the Catalog Graph.

Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
This commit is contained in:
milliehartnt123
2026-02-18 15:24:51 -05:00
committed by GitHub
parent 87de61ea70
commit 001c28bdb9
1 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/getting-started/viewing-entity-relationships.md
+9 -7
View File
@@ -12,13 +12,13 @@ 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).
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.
2. 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)
![Screenshot of the example-website Relations panel.](../assets/uiguide/example-website-relationships.png)
## Filtering the relationships
@@ -34,11 +34,13 @@ To display the Catalog Graph:
![Select View graph.](../assets/uiguide/select-view-graph.png)
The `Catalog Graph` is displayed.
The `Catalog Graph` is displayed.
![Screenshot of Catalog Graph.](../assets/uiguide/catalog-graph.png)
![Screenshot of Catalog Graph.](../assets/uiguide/catalog-graph.png)
You can set the following filters:
### Setting the filters
The `Catalog Graph` automatically reflects any changes you make to the filter settings. You can set the following filters:
- `MAX DEPTH`
- `MAX DEPTH` = 1