Add two new files
Added viewing-entity-relationships.md and view-what-you-own.md Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
This commit is contained in:
@@ -0,0 +1,22 @@
|
||||
---
|
||||
id: view-what-you-own
|
||||
title: Viewing what you own
|
||||
description: View the entities that you own either directly or through a group
|
||||
---
|
||||
|
||||
Audience: Developers
|
||||
|
||||
You can own entities either directly or through a group of which you are a part.
|
||||
|
||||
To view the entities that you own:
|
||||
|
||||
1. Select `Home` in the sidebar.
|
||||
2. Select `User` in the `Kind` dropdown list.
|
||||
3. Select your username in the `All Users` list.
|
||||
|
||||
A page is displayed that shows the entities of which you have owenership, either directly, or through a group of which you are a member. You can toggle between showing:
|
||||
|
||||
- `Direct Relations` - entities that you directly own
|
||||
- `Aggregated Relations `- entities that you own through your group
|
||||
|
||||

|
||||
@@ -0,0 +1,72 @@
|
||||
---
|
||||
id: viewing-entity-relationships
|
||||
title: Viewing entity relationships
|
||||
description: View the relationships between the entities in the Catalog
|
||||
---
|
||||
|
||||
Audience: Developers
|
||||
|
||||
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`.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
## Filtering the relationships
|
||||
|
||||
You can also view the relationships in the [Catalog Graph](../features/software-catalog/creating-the-catalog-graph.md)). This view allows you to filter what entities and relationships to display.
|
||||
|
||||
To display the Catalog Graph:
|
||||
|
||||
1. Select the name of the component in the main panel, in this example, `example-website`.
|
||||
|
||||
A page is displayed that includes a `Relations` section.
|
||||
|
||||
2. Select `View graph` in the `Relations` section.
|
||||
|
||||

|
||||
|
||||
The `Catalog Graph` is displayed.
|
||||
|
||||

|
||||
|
||||
You can set the following filters:
|
||||
|
||||
- `MAX DEPTH` - 1 or infinite
|
||||
|
||||

|
||||
|
||||
- `KINDS` - select what kinds of entities you want to view, default is all kinds
|
||||
- `RELATIONS` - select which relationships you want to view, default is all relationships
|
||||
- `Direction`- orientation in which you want to view the entity and its associated nodes
|
||||
- Top to botton
|
||||
- Bottom to top
|
||||
- Left to right
|
||||
- Right to left
|
||||
- `Curve`
|
||||
|
||||
- Monotone
|
||||
- Step Before
|
||||
|
||||

|
||||
|
||||
You can also toggle:
|
||||
|
||||
- `Simplified`
|
||||
- On = simple view
|
||||
- Off = detailed view
|
||||
- `Merge relations`
|
||||
|
||||
- On = You see the relationship from the selected entity to the nodes and from the nodes to the selected entity.
|
||||
|
||||
- Off = You only see relations from the selected entity to its nodes.
|
||||
|
||||

|
||||
Reference in New Issue
Block a user