Skip to content

Commit 21ed6f1

Browse files
pabel-rhpabel-rh
committed
Added content for software catalogs
1 parent 1f3ef29 commit 21ed6f1

11 files changed

+213
-0
lines changed

‎assemblies/assembly-about-software-catalogs.adoc‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
:context: about-software-catalogs
3+
[id="{context}"]
4+
= About Software Catalogs
5+
6+
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.
7+
8+
//[Add a Software Catalog screenshot of the latest build]
9+
10+
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.
11+
12+
//[Add any Component screenshot of the latest build]
13+
14+
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]
17+
include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1]
18+
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]
21+
include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1]
22+
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: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-adding-new-components-to-the-rhdh-instance_{context}"]
7+
= Adding new components to your {product} instance
8+
9+
As a developer, you can add components to your {product-short} instance in any of the following ways:
10+
11+
.Prerequisites
12+
13+
* You have installed the {product} instance.
14+
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
15+
16+
.Procedure
17+
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.

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-creating-new-components-in-the-rhdh-instance_{context}"]
7+
= Creating new components in your {product} instance
8+
9+
You can create new components in the Software Catalogs in one of the following ways:
10+
11+
.Prerequisites
12+
13+
* You have installed the {product} instance.
14+
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
15+
16+
.Procedure
17+
18+
* On *Home page > Catalog*, click *Self-service*.
19+
20+
{product} automatically registers all components that developers or platform engineers create using Templates in the Software Catalog.

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

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-registering-components-manually_{context}"]
7+
= Registering components manually
8+
9+
To register components in the Software Catalog manually, complete the following steps:
10+
11+
.Prerequisites
12+
13+
* You have installed the {product} instance.
14+
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
15+
16+
.Procedure
17+
18+
. On the Home page, click *Catalog*.
19+
. On the Catalog page, click *Register Existing Component*.
20+
. On the Register an existing component page, enter the full URL to the YAML file you wish to register. For example: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/components/artist-lookup-component.yaml
21+
. Complete the wizard instructions.

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-searching-and-filtering-software-catalogs-filter{context}"]
7+
= Searching and filtering software catalogs by using the Filter field
8+
9+
To filter a Software Catalog by using the *Filter* field, complete the following step:
10+
11+
.Procedure
12+
13+
. In the *Home page > Catalog*, enter the text you want to use to filter the components.

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-searching-and-filtering-software-catalogs-kind_{context}"]
7+
= Searching and filtering software catalogs by Kind
8+
9+
To filter a Software Catalog by its *Kind*, complete the following steps:
10+
11+
.Procedure
12+
13+
. On the Home page, click *Catalog*.
14+
. On the Red Hat Catalog page, click the *Kind* drop-down list.
15+
. Select the type of Kind you want to filter.
16+
+
17+
The available filter dropdowns vary based on the Kind you select, displaying options relevant to that specific entity type.

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

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-searching-and-filtering-software-catalogs_{context}"]
7+
= Searching and filtering software catalogs
8+
9+
You can search and filter Software Catalogs by its *Kind* or by using the *Filter* field.
10+
11+
.Procedure
12+
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:
14+
+
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.

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

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-starring-components-in-the-software-catalog_{context}"]
7+
= Starring components in the software catalog
8+
9+
To quickly access the Software Catalogs that you visit regularly, complete the following steps:
10+
11+
.Procedure
12+
13+
. On the Home page, click *Catalog*.
14+
. On the Red Hat Catalog page, on the Software Catalog that you want to star, under *Actions*, select the *Add to favorites* icon.
15+
16+
.Verification
17+
18+
. The starred component is listed under *Your Starred Entities* on your Home page.

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-updating-components-in-the-software-catalog_{context}"]
7+
= Updating components in the software catalog
8+
9+
To update components in the Software Catalog, complete the following steps:
10+
11+
.Prerequisites
12+
13+
* You have installed the {product} instance.
14+
* You have the required permissions as a Developer. See link:{authorization-book-url}[{authorization-book-title}].
15+
16+
.Procedure
17+
18+
. On *Home page > Catalog*, on the entity that you want to edit, under *Actions*, select the *Edit* icon.
19+
+
20+
This action redirects you to the YAML file on GitHub.
21+
. On your version control system, update your YAML file.
22+
+
23+
Once you merge your changes, the updated metadata in the Software Catalog appears after some time.

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="proc-viewing-software-catalog-yaml_{context}"]
7+
= Viewing the Software Catalog YAML file
8+
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.
15+
16+
.Procedure
17+
18+
. On the Home page, click *Catalog*.
19+
. 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.

0 commit comments

Comments
 (0)