Skip to content

Commit 395d7b7

Browse files
committed
Incorporated Lindsey's comments
1 parent 8200b85 commit 395d7b7

6 files changed

+49
-30
lines changed

assemblies/assembly-about-software-catalogs.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@
33
[id="{context}"]
44
= About Software Catalogs
55

6-
The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem from services, websites, libraries, data pipelines, and more. You can use it to view ownership details and metadata for each component in one place. By storing metadata in YAML files alongside the code, you allow {product} to process and display this information through a clear, visual interface. With the Software Catalog, you can manage and maintain your software, stay aware of all software available in your ecosystem, and take ownership of your services and tools.
6+
The {product} Software Catalog is a centralized system that gives you visibility into all the software across your ecosystem, including services, websites, libraries, and data pipelines. You can use it to view ownership details and metadata for each component in one place.
77

88
The metadata for the components in your Software Catalog is stored as YAML files that live alongside your code in your version control system. The version control repositories can include one or many metadata files. Software Catalog organizes items as entities, which include Components, Resources, and APIs, and other related types. Each entity includes associated metadata such as its owner, type, and other relevant details.
99

10+
By storing metadata in YAML files alongside the code, you allow {product} to process and display this information through a clear, visual interface. With the Software Catalog, you can manage and maintain your software, stay aware of all software available in your ecosystem, and take ownership of your services and tools.
11+
1012
//[Add a Software Catalog screenshot of the latest build]
1113

12-
The Overview page for a component provides key information such as links to the source code, documentation, dependencies, and ownership details. You can customize this page with plugins to suit specific needs.
14+
The *Overview* page for a component provides key information such as links to the source code, documentation, dependencies, and ownership details. You can customize this page with plugins to suit specific needs.
1315

1416
//[Add any Component screenshot of the latest build]
1517

modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,48 +5,46 @@
55
:_mod-docs-content-type: PROCEDURE
66
[id="proc-adding-new-components-to-the-rhdh-instance_{context}"]
77
= Adding new components to your {product} instance
8-
9-
You can add components to your {product-short} instance using the following ways:
108

119
.Prerequisites
1210

13-
* You have installed the {product} instance.
11+
* You have installed and configured the {product} instance.
1412
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
1513
1614
.Procedure
1715

18-
* Register components manually using the GUI or through your `{my-app-config-file}` with the required permissions.
19-
* Create new components through Software Templates.
16+
You can add components to your {product-very-short} instance using the following methods:
17+
18+
* Register components manually using the GUI or by using your `{my-app-config-file}` with the required permissions.
19+
* Create new components by using Software Templates.
2020
* Use the bulk import plugin with the required permissions. For more information, see link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[the bulk import plugin].
2121
2222
== Registering components manually in your {product-very-short} instance
2323

24-
To register components in the Software Catalog manually in your {product-very-short} instance, complete the following steps:
25-
2624
.Prerequisites
2725

28-
* You have installed the {product} instance.
26+
* You have installed and configured the {product} instance.
2927
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
3028

3129
.Procedure
3230

31+
To register components in the Software Catalog manually in your {product-very-short} instance, complete the following steps:
32+
3333
. In your {product} instance, go to *Home > Catalog*.
34-
. On the Catalog page, click *Register Existing Component*.
35-
. On the Register an existing component page, enter the full URL to the YAML file you wish to register. For example: link:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml[Artist lookup component].
34+
. On the *Catalog* page, click *Register Existing Component*.
35+
. On the *Register an existing component* page, enter the full URL to the YAML file you want to register. For example: link:https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml[Artist lookup component].
3636
. Complete the wizard instructions.
3737

3838
== Creating new components in your {product} instance
3939

40-
You can create new components in the Software Catalog in your {product-very-short} instance.
40+
You can create new components in the Software Catalog in your {product-very-short} instance. {product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.
4141

4242
.Prerequisites
4343

44-
* You have installed the {product} instance.
44+
* You have installed and configured the {product} instance.
4545
* You have the required permissions See link:{authorization-book-url}[{authorization-book-title}].
4646

4747
.Procedure
4848

4949
. In your {product} instance, go to *Home > Catalog*.
50-
* On the Catalog page, click *Self-service*.
51-
52-
{product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.
50+
* On the *Catalog* page, click *Self-service*.

modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ To filter a Software Catalog by its *Kind*, complete the following steps:
1515
.Procedure
1616

1717
. In your {product} instance, go to *Home > Catalog*.
18-
. On the Catalog page, click the *Kind* drop-down list.
19-
. Select the type of Kind you want to filter.
18+
. On the *Catalog* page, click the *Kind* drop-down list.
19+
. Select the type of *Kind* you want to filter.
2020
+
21-
The available filter dropdowns vary based on the Kind you select, displaying options relevant to that specific entity type.
21+
The available filter dropdowns vary based on the *Kind* you select, displaying options relevant to that specific entity type.
2222

2323
== Searching and Filtering Software Catalogs using the Filter field
2424

@@ -27,4 +27,4 @@ To filter a Software Catalog using the *Filter* field, complete the following st
2727
.Procedure
2828

2929
. In your {product} instance, go to *Home > Catalog*.
30-
. Enter the text you want to use to filter the components.
30+
. In the *Search* box, enter the text you want to use to filter the components.

modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,16 @@
66
[id="proc-starring-components-in-the-software-catalog_{context}"]
77
= Starring components in the Software Catalog
88

9-
To quickly access the Software Catalogs that you visit regularly, complete the following steps:
9+
10+
You can use the *Add to favorites* icon to add the software catalogs that you visit regularly to the *Starred* category.
1011

1112
.Procedure
1213

14+
To quickly access the Software Catalogs that you visit regularly, complete the following steps:
15+
1316
. In your {product} instance, go to *Home > Catalog*.
14-
. On the Home page, click *Catalog*.
15-
. On the Red Hat Catalog page, on the Software Catalog that you want to star, under *Actions*, select the *Add to favorites* icon.
17+
. On the *Home* page, click *Catalog*.
18+
. On the *Catalog* page, on the Software Catalog that you want to star, under *Actions*, select the *Add to favorites* icon.
1619

1720
.Verification
1821

modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,29 @@
66
[id="proc-updating-components-in-the-software-catalog_{context}"]
77
= Updating components in the Software Catalog in your {product} instance
88

9-
To update components in the Software Catalog in your {product} instance, complete the following steps:
9+
You can update components in the Software Catalog in your {product} instance.
1010

1111
.Prerequisites
1212

13-
* You have installed the {product} instance.
13+
* You have installed and configured the {product} instance.
1414
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
1515
1616
.Procedure
1717

18+
To update components in the Software Catalog in your {product} instance, complete the following steps:
19+
1820
. In your {product} instance, go to *Home > Catalog*.
1921
. On *Home page > Catalog*, on the entity that you want to edit, under *Actions*, select the *Edit* icon.
22+
2023
+
24+
[NOTE]
25+
====
2126
This action redirects you to the YAML file on GitHub.
27+
====
2228
. On your version control system, update your YAML file.
29+
2330
+
24-
Once you merge your changes, the updated metadata in the Software Catalog appears after some time.
31+
[NOTE]
32+
====
33+
After you merge your changes, the updated metadata in the Software Catalog appears after some time.
34+
====

modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,17 @@
66
[id="proc-viewing-software-catalog-yaml_{context}"]
77
= Viewing the Software Catalog YAML file in your {product} instance
88

9-
To view the Software Catalog YAML file in your {product} instance, complete the following steps:
9+
You can view the Software Catalog YAML file in your {product} instance. The YAML file displays the metadata for the components in your Software Catalog.
1010

1111
.Procedure
1212

13+
To view the Software Catalog YAML file in your {product} instance, complete the following steps:
14+
1315
. In your {product} instance, go to *Home > Catalog*.
14-
. On the Red Hat Catalog page, on the Software Catalog that you want to star, under *Actions*, select the *View* icon.
16+
. On the *Catalog* page, on the Software Catalog that you want to star, under *Actions*, select the *View* icon.
17+
1518
+
16-
This action redirects you to the YAML file on your version control.
19+
[NOTE]
20+
====
21+
These steps redirect you to the YAML file on your version control.
22+
====

0 commit comments

Comments
 (0)