Revise catalog documentation for clarity and accuracy
Updated terminology and fixed typos in the catalog documentation. Updated several links. Fixed items found by Copilot and DOC SIG review. Signed-off-by: milliehartnt123 <108491788+milliehartnt123@users.noreply.github.com>
This commit is contained in:
@@ -18,16 +18,20 @@ The [Technical Overview](../overview/technical-overview.md#software-catalog-syst
|
||||
- `Components` - Individual pieces of software that can be tracked in source control and can implement APIs for other components to consume.
|
||||
- `APIs` - Implemented by components and form the boundaries between different components. The API can be either public, restricted, or private.
|
||||
- `Resources` - The physical or virtual infrastructure needed to operate a component.
|
||||
- `Location` - A marker that references other places to look for catalog data.
|
||||
- `Template` - Describes both the parameters that are rendered in the frontend part of the scaffolding wizard, and the steps that are executed when scaffolding that component.
|
||||
- `Systems` - A collection of resources and components that cooperate to perform a function by exposing one or several public APIs. It hides the resources and private APIs between the components from the consumer.
|
||||
- `Domains` - A collection of systems that share terminology, domain models, metrics, KPIs, business purpose, or documentation.
|
||||
|
||||
- **Organizational Entities**
|
||||
|
||||
- `User` - A person, such as an employee, contractor, or similar.
|
||||
- `Group` - An organizational entity, such as a team, business unit, and so on.
|
||||
|
||||
There are two additional items that can be part of the system model:
|
||||
There is an additional item that can be part of the system model:
|
||||
|
||||
- `Type` - It has no set meaning. You can assign your own types and use them as desired.
|
||||
- `Template` - Describes both the parameters that are rendered in the frontend part of the scaffolding wizard, and the steps that are executed when scaffolding that component.
|
||||
|
||||
|
||||
It should be noted that you can also [create your own kinds of entities](../features/software-catalog/extending-the-model.md#adding-a-new-kind), if you need to model something in your organization that does not map to one of the existing entity types.
|
||||
|
||||
@@ -36,7 +40,7 @@ Initially, the Catalog displays registered entities matching the following filte
|
||||
- `Kind` - Component
|
||||
- `Type` - all
|
||||
- `Owner` - Owned
|
||||
- `Lifecycle` - list of lifecycle values of entities in the Catalog
|
||||
- `Lifecycle` - list of [lifecycle](../features/software-catalog/descriptor-format.md#speclifecycle-required-1) values of entities in the Catalog
|
||||
- `Processing Status` - normal
|
||||
- `Namespace` - The ID of a [namespace](../features/software-catalog/descriptor-format.md#namespace-optional) to which the entity belongs
|
||||
|
||||
@@ -49,11 +53,11 @@ For each kind of entity, a set of columns display information regarding the enti
|
||||
- `Name` - the name of the component
|
||||
- `System` - an optional field that references the system to which the component belongs
|
||||
- `Owner` - the owner of the component
|
||||
- `Type` - common types are as follows, but you can [create a new type](../features/software-catalog/extending-the-model.md#adding-a-new-kind) to meet your organization's needs
|
||||
- `Type` - common types are as follows, but you can [create a new type](../features/software-catalog/extending-the-model.md#adding-a-new-type-of-an-existing-kind) to meet your organization's needs
|
||||
- `service` - a backend service, typically exposing an API
|
||||
- `website` - a website
|
||||
- `library` - a software library, such as an npm module or a Java library
|
||||
- `Lifecyle`
|
||||
- `Lifecycle`
|
||||
- `experimental` - an experiment or early, non-production component, signaling
|
||||
that users may not prefer to consume it over other more established
|
||||
components, or that there are low or no reliability guarantees
|
||||
@@ -64,26 +68,28 @@ For each kind of entity, a set of columns display information regarding the enti
|
||||
- `Tags` - an optional field that can be used for searching
|
||||
- `Actions` - see [Catalog Actions](#catalog-actions)
|
||||
|
||||
You can modify the columns associated with each kind of entity, following the instructions in [Customize Columns](../features/software-catalog/catalog-customization.md#customize-actions).
|
||||
You can modify the columns associated with each kind of entity, following the instructions in [Customize Columns](../features/software-catalog/catalog-customization.md#customize-columns).
|
||||
|
||||
## Catalog Actions
|
||||
|
||||
For each entity, there are a set of actions that are available.
|
||||
For each entity, there are a set of actions that are available.
|
||||
|
||||

|
||||
|
||||
From left to right, the actions are:
|
||||
|
||||
- View - View the `catalog-info.yaml` file that defines the entity.
|
||||
- Edit - Edit the `catalog-info.yaml` file that defines the entity. See [Updating a Component](../getting-started/update-a-component.md)
|
||||
- Star - Designate the entity as a favorite. You can filter and [search](../getting-started/search-catalog.md) for starred entities.
|
||||
|
||||

|
||||
- Star - Designate the entity as a favorite. You can [filter](../getting-started/filter-catalog.md) the catalog for starred entities.
|
||||
|
||||
[Customize Actions](../features/software-catalog/catalog-customization.md#customize-actions) describes how you can modify the actions that are displayed.
|
||||
|
||||
## Viewing entity details
|
||||
|
||||
Selecting a entity in the main panel displays details of the entity. The type of details depends on the type of entity. For example, selecting a Component, such as `example-website`, displays the following details:
|
||||
Selecting an entity in the main panel displays details of the entity. The type of details depends on the type of entity. For example, selecting a Component, such as `example-website`, displays the following details:
|
||||
|
||||
- `About` - Metadata for the entity, such as description, owner,tags,and domain.
|
||||
- `Relations` - see [Viewing entity relations](#viewing-entitiy-relationships)
|
||||
- `About` - Metadata for the entity, such as description, owner, tags, and domain.
|
||||
- `Relations` - see [Viewing entity relations](../getting-started/viewing-entitiy-relationships.md)
|
||||
- `Links` - any links associated with the entity
|
||||
- `Has subcomponents` - An entity reference to another component of which the component is a part
|
||||
|
||||
|
||||
Reference in New Issue
Block a user