Skip to content

Commit 8200b85

Browse files
committed
Incorporated Heena's comments
1 parent 21ed6f1 commit 8200b85

10 files changed

+68
-115
lines changed

assemblies/assembly-about-software-catalogs.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
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.
7+
68
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.
79

810
//[Add a Software Catalog screenshot of the latest build]
@@ -12,11 +14,7 @@ The Overview page for a component provides key information such as links to the
1214
//[Add any Component screenshot of the latest build]
1315

1416
include::modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1]
15-
include::modules/software-catalogs/proc-registering-components-manually.adoc[leveloffset=+2]
16-
include::modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc[leveloffset=+2]
1717
include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1]
1818
include::modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc[leveloffset=+1]
19-
include::modules/software-catalogs/proc-searching-and-filter-software-catalogs-kind.adoc[leveloffset=+2]
20-
include::modules/software-catalogs/proc-searching-and-filter-software-catalogs-filter.adoc[leveloffset=+2]
2119
include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1]
2220
include::modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc[leveloffset=+1]

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

Lines changed: 37 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,47 @@
66
[id="proc-adding-new-components-to-the-rhdh-instance_{context}"]
77
= Adding new components to your {product} instance
88

9-
As a developer, you can add components to your {product-short} instance in any of the following ways:
9+
You can add components to your {product-short} instance using the following ways:
1010

1111
.Prerequisites
1212

1313
* You have installed the {product} instance.
14-
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
14+
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
1515
1616
.Procedure
1717

18-
* Registering components manually using the GUI or through your `{my-app-config-file}` with the required permissions.
19-
* Creating new components through Software Templates.
20-
* Using the link:{configuring-dynamic-plugins-book-url}#bulk-importing-github-repositories[bulk import plugin] with the required permissions.
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.
20+
* 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].
21+
22+
== Registering components manually in your {product-very-short} instance
23+
24+
To register components in the Software Catalog manually in your {product-very-short} instance, complete the following steps:
25+
26+
.Prerequisites
27+
28+
* You have installed the {product} instance.
29+
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
30+
31+
.Procedure
32+
33+
. 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].
36+
. Complete the wizard instructions.
37+
38+
== Creating new components in your {product} instance
39+
40+
You can create new components in the Software Catalog in your {product-very-short} instance.
41+
42+
.Prerequisites
43+
44+
* You have installed the {product} instance.
45+
* You have the required permissions See link:{authorization-book-url}[{authorization-book-title}].
46+
47+
.Procedure
48+
49+
. 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.

modules/software-catalogs/proc-creating-new-components-in-the-rhdh-instance.adoc

Lines changed: 0 additions & 20 deletions
This file was deleted.

modules/software-catalogs/proc-registering-components-manually.adoc

Lines changed: 0 additions & 21 deletions
This file was deleted.

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

Lines changed: 0 additions & 13 deletions
This file was deleted.

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

Lines changed: 0 additions & 17 deletions
This file was deleted.

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

Lines changed: 18 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,27 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="proc-searching-and-filtering-software-catalogs_{context}"]
7-
= Searching and filtering software catalogs
7+
= Searching and filtering Software Catalogs
88

99
You can search and filter Software Catalogs by its *Kind* or by using the *Filter* field.
1010

11+
== Searching and Filtering Software Catalogs by Kind
12+
13+
To filter a Software Catalog by its *Kind*, complete the following steps:
14+
1115
.Procedure
1216

13-
* In the `{my-app-config-file}` configuration file, modify the `catalog.rules` section to include a rule for templates, and configure the `catalog.locations` section to point to the template that you want to add, as shown in the following example:
17+
. 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.
1420
+
15-
[source,yaml]
16-
----
17-
# ...
18-
catalog:
19-
rules:
20-
- allow: [Template] # <1>
21-
locations:
22-
- type: url # <2>
23-
target: https://<repository_url>/example-template.yaml # <3>
24-
# ...
25-
----
26-
<1> To allow new templates to be added to the catalog, you must add a `Template` rule.
27-
<2> If you are importing templates from a repository, such as GitHub or GitLab, use the `url` type.
28-
<3> Specify the URL for the template.
29-
30-
.Verification
31-
32-
. Click the *Catalog* tab in the navigation panel.
33-
. In the *Kind* drop-down menu, select *Template*.
34-
. Confirm that your template is shown in the list of existing templates.
21+
The available filter dropdowns vary based on the Kind you select, displaying options relevant to that specific entity type.
22+
23+
== Searching and Filtering Software Catalogs using the Filter field
24+
25+
To filter a Software Catalog using the *Filter* field, complete the following steps:
26+
27+
.Procedure
28+
29+
. In your {product} instance, go to *Home > Catalog*.
30+
. Enter the text you want to use to filter the components.

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,13 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="proc-starring-components-in-the-software-catalog_{context}"]
7-
= Starring components in the software catalog
7+
= Starring components in the Software Catalog
88

99
To quickly access the Software Catalogs that you visit regularly, complete the following steps:
1010

1111
.Procedure
1212

13+
. In your {product} instance, go to *Home > Catalog*.
1314
. On the Home page, click *Catalog*.
1415
. On the Red Hat Catalog page, on the Software Catalog that you want to star, under *Actions*, select the *Add to favorites* icon.
1516

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="proc-updating-components-in-the-software-catalog_{context}"]
7-
= Updating components in the software catalog
7+
= Updating components in the Software Catalog in your {product} instance
88

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

1111
.Prerequisites
1212

1313
* You have installed the {product} instance.
14-
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
14+
* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}].
1515
1616
.Procedure
1717

18+
. In your {product} instance, go to *Home > Catalog*.
1819
. On *Home page > Catalog*, on the entity that you want to edit, under *Actions*, select the *Edit* icon.
1920
+
2021
This action redirects you to the YAML file on GitHub.

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,13 @@
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="proc-viewing-software-catalog-yaml_{context}"]
7-
= Viewing the Software Catalog YAML file
7+
= Viewing the Software Catalog YAML file in your {product} instance
88

9-
To view the Software Catalog YAML file, complete the following step:
10-
11-
.Prerequisites
12-
13-
* You have created a directory or repository that contains at least one template YAML file.
14-
* If you want to use a template that is stored in a repository such as GitHub or GitLab, you must configure a {product} integration for your provider.
9+
To view the Software Catalog YAML file in your {product} instance, complete the following steps:
1510

1611
.Procedure
1712

18-
. On the Home page, click *Catalog*.
13+
. In your {product} instance, go to *Home > Catalog*.
1914
. On the Red Hat Catalog page, on the Software Catalog that you want to star, under *Actions*, select the *View* icon.
20-
This action redirects you to the YAML file on your version control.
15+
+
16+
This action redirects you to the YAML file on your version control.

0 commit comments

Comments
 (0)