diff --git a/assemblies/assembly-about-software-catalogs.adoc b/assemblies/assembly-about-software-catalogs.adoc new file mode 100644 index 0000000000..30fecd31b4 --- /dev/null +++ b/assemblies/assembly-about-software-catalogs.adoc @@ -0,0 +1,22 @@ +:_mod-docs-content-type: ASSEMBLY +:context: about-software-catalogs +[id="{context}"] += About Software Catalogs + +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. + +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. + +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. + +//[Add a Software Catalog screenshot of the latest build] + +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. + +//[Add any Component screenshot of the latest build] + +include::modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc[leveloffset=+1] +include::modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc[leveloffset=+1] +include::modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc[leveloffset=+1] +include::modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc[leveloffset=+1] +include::modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc new file mode 100644 index 0000000000..caa5ace38c --- /dev/null +++ b/modules/software-catalogs/proc-adding-new-components-to-the-rhdh-instance.adoc @@ -0,0 +1,50 @@ +// Module included in the following assemblies: +// +// * assemblies/assembly-about-software-catalogs.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-adding-new-components-to-the-rhdh-instance_{context}"] += Adding new components to your {product} instance + +.Prerequisites + +* You have installed and configured the {product} instance. +* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. + +.Procedure + +You can add components to your {product-very-short} instance using the following methods: + +* Register components manually using the GUI or by using your `{my-app-config-file}` with the required permissions. +* Create new components by using Software Templates. +* 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]. + +== Registering components manually in your {product-very-short} instance + +.Prerequisites + +* You have installed and configured the {product} instance. +* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. + +.Procedure + +To register components in the Software Catalog manually in your {product-very-short} instance, complete the following steps: + +. In your {product} navigation menu, click *Catalog*. +. On the *Catalog* page, click *Register Existing Component*. +. 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]. +. Complete the wizard instructions. + +== Creating new components in your {product} instance + +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. + +.Prerequisites + +* You have installed and configured the {product} instance. +* You have the required permissions See link:{authorization-book-url}[{authorization-book-title}]. + +.Procedure + +. In your {product} navigation menu, click *Catalog*. +* On the *Catalog* page, click *Self-service*. \ No newline at end of file diff --git a/modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc b/modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc new file mode 100644 index 0000000000..acafe6c2a4 --- /dev/null +++ b/modules/software-catalogs/proc-searching-and-filter-software-catalogs.adoc @@ -0,0 +1,30 @@ +// Module included in the following assemblies: +// +// * assemblies/assembly-about-software-catalogs.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-searching-and-filtering-software-catalogs_{context}"] += Searching and filtering Software Catalogs + +You can search and filter Software Catalogs by its *Kind* or by using the *Filter* field. + +== Searching and Filtering Software Catalogs by Kind + +To filter a Software Catalog by its *Kind*, complete the following steps: + +.Procedure + +. In your {product} navigation menu, click *Catalog*. +. On the *Catalog* page, click the *Kind* drop-down list. +. Select the type of *Kind* you want to filter. ++ +The available filter dropdowns vary based on the *Kind* you select, displaying options relevant to that specific entity type. + +== Searching and Filtering Software Catalogs using the Filter field + +To filter a Software Catalog using the *Filter* field, complete the following steps: + +.Procedure + +. In your {product} navigation menu, click *Catalog*. +. In the *Search* box, enter the text you want to use to filter the components. \ No newline at end of file diff --git a/modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc b/modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc new file mode 100644 index 0000000000..e007469b83 --- /dev/null +++ b/modules/software-catalogs/proc-starring-components-in-the-software-catalog.adoc @@ -0,0 +1,21 @@ +// Module included in the following assemblies: +// +// * assemblies/assembly-about-software-catalogs.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-starring-components-in-the-software-catalog_{context}"] += Starring components in the Software Catalog + + +You can use the *Add to favorites* icon to add the software catalogs that you visit regularly to the *Starred* category. + +.Procedure + +To quickly access the Software Catalogs that you visit regularly, complete the following steps: + +. In your {product} navigation menu, click *Catalog*. +. On the *Catalog* page, on the Software Catalog that you want to star, under *Actions*, select the *Add to favorites* icon. + +.Verification + +. The starred component is listed under *Your Starred Entities* on your Home page. \ No newline at end of file diff --git a/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc new file mode 100644 index 0000000000..61d9b99a6f --- /dev/null +++ b/modules/software-catalogs/proc-updating-components-in-the-software-catalog.adoc @@ -0,0 +1,35 @@ +// Module included in the following assemblies: +// +// * assemblies/assembly-about-software-catalogs.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-updating-components-in-the-software-catalog_{context}"] += Updating components in the Software Catalog in your {product} instance + +You can update components in the Software Catalog in your {product} instance. + +.Prerequisites + +* You have installed and configured the {product} instance. +* You have the required permissions. See link:{authorization-book-url}[{authorization-book-title}]. + +.Procedure + +To update components in the Software Catalog in your {product} instance, complete the following steps: + +. In your {product} navigation menu, click *Catalog*. +. On the *Catalog* page, on the entity that you want to edit, under *Actions*, select the *Edit* icon. + ++ +[NOTE] +==== +This action redirects you to the YAML file on GitHub. +==== + +. On your version control system, update your YAML file. + ++ +[NOTE] +==== +After you merge your changes, the updated metadata in the Software Catalog appears after some time. +==== \ No newline at end of file diff --git a/modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc b/modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc new file mode 100644 index 0000000000..8aef2bc189 --- /dev/null +++ b/modules/software-catalogs/proc-viewing-software-catalog-yaml.adoc @@ -0,0 +1,22 @@ +// Module included in the following assemblies: +// +// * assemblies/assembly-about-software-catalogs.adoc + +:_mod-docs-content-type: PROCEDURE +[id="proc-viewing-software-catalog-yaml_{context}"] += Viewing the Software Catalog YAML file in your {product} instance + +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. + +.Procedure + +To view the Software Catalog YAML file in your {product} instance, complete the following steps: + +. In your {product} navigation menu, click *Catalog*. +. On the *Catalog* page, on the Software Catalog that you want to star, under *Actions*, select the *View* icon. + ++ +[NOTE] +==== +These steps redirect you to the YAML file on your version control. +==== \ No newline at end of file diff --git a/titles/customizing/master.adoc b/titles/customizing/master.adoc index 0deecf5c34..b63de7dc97 100644 --- a/titles/customizing/master.adoc +++ b/titles/customizing/master.adoc @@ -20,13 +20,18 @@ include::modules/customizing/proc-customizing-the-backend-secret.adoc[leveloffse include::assemblies/assembly-configuring-templates.adoc[leveloffset=+1] +include::assemblies/assembly-about-software-catalogs.adoc[leveloffset=+1] + + include::assemblies/assembly-customizing-the-learning-paths.adoc[leveloffset=+1] include::assemblies/assembly-configuring-the-global-header.adoc[leveloffset=+1] + include::assemblies/assembly-configuring-a-floating-action-button.adoc[leveloffset=+1] + include::modules/customizing-the-tech-radar-page/proc-customize-rhdh-tech-radar-page.adoc[leveloffset=+1]