Repository: redhat-developer/red-hat-developers-documentation-rhdh
Pull request #1098: RHIDP-6145: Added developer-focused content for software templates
Author: login: pabel-rh
Labels: name: Technical review done :partly_sunny:
description: Any procedure has been succesfully tested
name: Ready to merge  :guard:
name: Peer review done :blue_book:
name: lgtm
Created: 2025-04-24T16:26:15Z | Merged: 2025-05-14T10:43:49Z

<!--- PR title format: [GH#<gh-issue-id>][BZ#<bz-issue-id>][RHIDP#<jira-issue-id>]: <short-description-of-the-pr> --->

<!--- If your changes apply to the latest released and/or in-development version of RHDH, open your PR against the `main` branch and cherrypick your PR to any released branches that you want to apply your changes to. --->

<!--- Add the relevant labels to the Pull Request. Update the labels, as needed, to reflect the current status of the PR. --->


**IMPORTANT: Do Not Merge - To be merged by Docs Team Only**

**Version(s):**
1.6, main
**Issue:**
[RHIDP-6145](https://issues.redhat.com/browse/RHIDP-6145)
**Preview:**
https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1098/customizing/#configuring-templates



Diff:
diff --git a/assemblies/assembly-configuring-templates.adoc b/assemblies/assembly-configuring-templates.adoc
index 29d502b62e1..5d69a69b472 100644
--- a/assemblies/assembly-configuring-templates.adoc
+++ b/assemblies/assembly-configuring-templates.adoc
@@ -1,23 +1,25 @@
 :_mod-docs-content-type: ASSEMBLY
 :context: configuring-templates
 [id="{context}"]
-= Configuring templates
+= About Software Templates
 
-Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
+Software Templates in {product} provide a streamlined way to create software components and publish them to different version control repositories like Git. Platform engineers create and maintain Software Templates in {product}.
 
-A template is a form composed of different UI fields that is defined in a YAML file. Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
+You can configure Software Templates to create software components, and publish these components to Git repositories. Once the components are published to Git repositories, register these components in the Software Catalog.
+
+A template is a form composed of different UI fields that is defined in a YAML file. Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
+
+* See link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better Backstage Software Templates].
 
 include::modules/customizing-templates/proc-creating-templates.adoc[leveloffset=+1]
 include::modules/customizing-templates/ref-creating-templates.adoc[leveloffset=+1]
+include::modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1]
+include::modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]
+include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
 
 [role="_additional-resources"]
 .Additional resources
+* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
 * link:https://backstage.io/docs/features/software-templates/writing-templates[Backstage documentation - Writing Templates]
 * link:https://backstage.io/docs/features/software-templates/builtin-actions[Backstage documentation - Builtin actions]
 * link:https://backstage.io/docs/features/software-templates/writing-custom-actions[Backstage documentation - Writing Custom Actions]
-
-include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
-
-[role="_additional-resources"]
-.Additional resources
-* link:{authentication-book-url}#assembly-auth-provider-github[Enabling the GitHub authentication provider]
diff --git a/images/rhdh/template-creation-not-successful.png b/images/rhdh/template-creation-not-successful.png
new file mode 100644
index 00000000000..6fc1a920acf
Binary files /dev/null and b/images/rhdh/template-creation-not-successful.png differ
diff --git a/images/rhdh/template-creation-successful.png b/images/rhdh/template-creation-successful.png
new file mode 100644
index 00000000000..37d21d19d80
Binary files /dev/null and b/images/rhdh/template-creation-successful.png differ
diff --git a/images/rhdh/template-editor.png b/images/rhdh/template-editor.png
index 43b7497cf90..c8077ef46d9 100644
Binary files a/images/rhdh/template-editor.png and b/images/rhdh/template-editor.png differ
diff --git a/modules/customizing-templates/proc-adding-templates.adoc b/modules/customizing-templates/proc-adding-templates.adoc
index 837b3c9e346..d71bfd491d8 100644
--- a/modules/customizing-templates/proc-adding-templates.adoc
+++ b/modules/customizing-templates/proc-adding-templates.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-adding-templates_{context}"]
-= Importing an existing template to {product}
+= Importing an existing Software Template to {product}
 
-You can add an existing template to your {product} instance by using the Catalog Processor.
+You can add an existing Software Template to your {product} instance by using the Catalog Processor.
 
 .Prerequisites
 
@@ -15,7 +15,7 @@ You can add an existing template to your {product} instance by using the Catalog
 
 .Procedure
 
-* 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:
+* In the `{my-app-config-file}` configuration file, modify the `catalog.rules` section to include a rule for Software Templates, and configure the `catalog.locations` section to point to the Software Template that you want to add, as shown in the following example:
 +
 [source,yaml]
 ----
@@ -28,7 +28,7 @@ catalog:
       target: https://<repository_url>/example-template.yaml # <3>
 # ...
 ----
-<1> To allow new templates to be added to the catalog, you must add a `Template` rule.
+<1> To allow new Software Templates to be added to the catalog, you must add a `Template` rule.
 <2> If you are importing templates from a repository, such as GitHub or GitLab, use the `url` type.
 <3> Specify the URL for the template.
 
diff --git a/modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc b/modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
new file mode 100644
index 00000000000..b202252a6fe
--- /dev/null
+++ b/modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
@@ -0,0 +1,40 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard Software Templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+* Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*. 
++
+[NOTE]
+====
+This step is available only for a few templates.
+====
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is then sent to a task and none of the following steps are executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* If your software component is not created successfully, you can review the logs on the error page. To return to the *Self-service* page with the same template form and your previously entered values, click *Start Over*.
+
+image::rhdh/template-creation-not-successful.png[]
+
+* If your Software Template is created successfully, a success page similar to the example in the following image is displayed:
++
+--
+image::rhdh/template-creation-successful.png[template-creation-successful]
+--
diff --git a/modules/customizing-templates/proc-creating-templates.adoc b/modules/customizing-templates/proc-creating-templates.adoc
index 7dd2ccdf998..2dfa7c14fc5 100644
--- a/modules/customizing-templates/proc-creating-templates.adoc
+++ b/modules/customizing-templates/proc-creating-templates.adoc
@@ -4,9 +4,9 @@
 
 :_mod-docs-content-type: PROCEDURE
 [id="proc-creating-templates_{context}"]
-= Creating a template by using the Template Editor
+= Creating a Software Template by using the Template Editor
 
-You can create a template by using the Template Editor.
+You can create a Software Template by using the Template Editor.
 
 .Procedure
 
@@ -16,7 +16,7 @@ image::rhdh/template-editor.png[Template Editor]
 ** Open the URL `\https://<rhdh_url>/create/edit` for your {product} instance.
 ** Click *Self-service* in the navigation menu of the {product} console, then click the overflow menu button and select *Template editor*.
 . Click *Edit Template Form*.
-. Optional: Modify the YAML definition for the parameters of your template. For more information about these parameters, see <<Creating a template as a YAML file>>.
+. Optional: Modify the YAML definition for the parameters of your template. For more information about these parameters, see <<Creating a Software Template as a YAML file>>.
 . In the *Name* field, enter a unique name for your template.
 . From the *Owner* drop-down menu, choose an owner for the template.
 . Click *Next*.
diff --git a/modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc b/modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
new file mode 100644
index 00000000000..e549c50d599
--- /dev/null
+++ b/modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
@@ -0,0 +1,17 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
+. In the {product} navigation menu, click *Catalog* > *Self-service*.
+. Type the name of the template you are looking for in the *Search* box.
+* If you are looking for templates in a certain category, you can use the *Categories* dropdown.
\ No newline at end of file
diff --git a/modules/customizing-templates/ref-creating-templates.adoc b/modules/customizing-templates/ref-creating-templates.adoc
index b0e3e71ff14..c6d5ac2e848 100644
--- a/modules/customizing-templates/ref-creating-templates.adoc
+++ b/modules/customizing-templates/ref-creating-templates.adoc
@@ -4,11 +4,11 @@
 
 :_mod-docs-content-type: REFERENCE
 [id="ref-creating-templates_{context}"]
-= Creating a template as a YAML file
+= Creating a Software Template as a YAML file
 
-You can create a template by defining a `Template` object as a YAML file.
+You can create a Software Template by defining a `Template` object as a YAML file.
 
-The `Template` object describes the template and its metadata. It also contains required input variables and a list of actions that are executed by the scaffolding service.
+The `Template` object describes the Software Template and its metadata. It also contains required input variables and a list of actions that are executed by the scaffolding service.
 
 .`Template` object example
 [source,yaml]
@@ -56,10 +56,10 @@ spec:
         entityRef: ${{ steps['register'].output.entityRef }}
 # ...
 ----
-<1> Specify a name for the template.
-<2> Specify a title for the template. This is the title that is visible on the template tile in the *Self-service* view.
-<3> Specify a description for the template. This is the description that is visible on the template tile in the *Self-service* view.
-<4> Specify the ownership of the template. The `owner` field provides information about who is responsible for maintaining or overseeing the template within the system or organization. In the provided example, the `owner` field is set to `backstage/techdocs-core`. This means that this template belongs to the `techdocs-core` project in the `backstage` namespace.
+<1> Specify a name for the Software Template.
+<2> Specify a title for the Software Template. This is the title that is visible on the Software Template tile in the *Self-service* view.
+<3> Specify a description for the Software Template. This is the description that is visible on the Software Template tile in the *Self-service* view.
+<4> Specify the ownership of the Software Template. The `owner` field provides information about who is responsible for maintaining or overseeing the Software Template within the system or organization. In the provided example, the `owner` field is set to `backstage/techdocs-core`. This means that this Software Template belongs to the `techdocs-core` project in the `backstage` namespace.
 <5> Specify the component type. Any string value is accepted for this required field, but your organization should establish a proper taxonomy for these. {product} instances may read this field and behave differently depending on its value. For example, a `website` type component may present tooling in the {product} interface that is specific to just websites.
 +
 The following values are common for this field:
@@ -69,7 +69,7 @@ The following values are common for this field:
 `website`:: A website.
 `library`:: A software library, such as an npm module or a Java library.
 --
-<6> Use the `parameters` section to specify parameters for user input that are shown in a form view when a user creates a component by using the template in the {product} console. Each `parameters` subsection, defined by a title and properties, creates a new form page with that definition.
+<6> Use the `parameters` section to specify parameters for user input that are shown in a form view when a user creates a component by using the Software Template in the {product} console. Each `parameters` subsection, defined by a title and properties, creates a new form page with that definition.
 <7> Use the `steps` section to specify steps that are executed in the backend. These steps must be defined by using a unique step ID, a name, and an action. You can view actions that are available on your {product} instance by visiting the URL `\https://<rhdh_url>/create/actions`.
 <8> Use the `output` section to specify the structure of output data that is created when the template is used. The `output` section, particularly the `links` subsection, provides valuable references and URLs that users can utilize to access and interact with components that are created from the template.
 <9> Provides a reference or URL to the repository associated with the generated component.


Reviews:
user: login: linfraze
body: Thank you for the content! A few comments and suggestions
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-04-24T17:11:13Z
user: login: pabel-rh
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-04-25T05:20:45Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:19:53Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:20:33Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:21:28Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:23:01Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:28:12Z
user: login: themr0c
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-02T09:29:29Z
user: login: debsmita1
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-05T12:22:20Z
user: login: debsmita1
state: CHANGES_REQUESTED
author_association: MEMBER
submitted_at: 2025-05-14T07:02:25Z
user: login: pabel-rh
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-14T08:52:29Z
user: login: debsmita1
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-14T09:57:21Z
user: login: debsmita1
body: /lgtm

Thanks @pabel-rh !
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-05-14T10:07:53Z
user: login: debsmita1
state: APPROVED
author_association: MEMBER
submitted_at: 2025-05-14T10:29:40Z

Review comments:
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: ```suggestion
You can create a new software component using the standard templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
```
created_at: 2025-04-24T16:56:59Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: ```suggestion
. In the {product} navigation menu, click *Catalog* > *Self-service*.
```


created_at: 2025-04-24T16:57:53Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: Is it the ***Self-service*** page, or the *Software Templates* page? I see the ***Software Templates*** page, but I might not be using the latest version of RHDH
created_at: 2025-04-24T17:01:41Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+Each template requires you to provide different information.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: ```suggestion
The information that you enter for a software template is specific to that template.
```
^just a suggestion to improve clarity
created_at: 2025-04-24T17:03:06Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+Each template requires you to provide different information.
+====
+
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is, then, sent to a task and all the next steps are not executed. 
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: ```suggestion
* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is then sent to a task and none of the following steps are executed. 
```
created_at: 2025-04-24T17:05:29Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+Each template requires you to provide different information.
+====
+
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is, then, sent to a task and all the next steps are not executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is, then, sent to a task and all the next steps are not executed. 
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: ```suggestion

```
This is repeated as an admonition and it doesn't seem like a verification step
created_at: 2025-04-24T17:06:15Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+Each template requires you to provide different information.
+====
+
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is, then, sent to a task and all the next steps are not executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is, then, sent to a task and all the next steps are not executed. 
+* During the creation of the software component, click  *Show Logs*to view the log information.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: linfraze
body: This doesn't really seem like a step that verifies the successful completion of the procedure either. Consider removing the .Verification section from this procedure.
created_at: 2025-04-24T17:07:21Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
path: modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
user: login: linfraze
body: ```suggestion
. In the {product} navigation menu, click *Catalog* > *Self-service*.
```
created_at: 2025-04-24T17:08:01Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. Based on your requirement, select any option from any of the following dropdowns:
path: modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
user: login: linfraze
body: ```suggestion
. Based on your requirement, select any option from any of the following drop-down menus:
```
created_at: 2025-04-24T17:08:28Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. Based on your requirement, select any option from any of the following dropdowns:
+** *Categories*
+** *Owner*
path: modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
user: login: linfraze
body: This renders fine, but I think these can be `*` rather than `**`
created_at: 2025-04-24T17:09:26Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,24 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-viewing-the-results-of-software-component-creation_{context}"]
+= Viewing the results of the software component creation in your {product} instance
+
+You can verify the results of the software component creation using various methods.
+
+.Procedure
+
+To view and verify the results of the software component that is created, complete the following steps:
+
+* If your software component is not successfully created, you can click on each section in the *Self-service* page to view the log information from the step that failed.
+
+* If your template is successfully created, you can view the component by clicking the following links on the success page:
+** *Source Repository*
+** *GitOps Repository*
+** *Open Component in Catalog*
+** *Open GitOps Resource in Catalog*
+
+* To view the software component that you have just created, click *Open Component in catalog*, or in your {product} instance, go to the *Home* page, and click *Catalog*.
+To view the Source Code in your version control, click *Source Code Repository*.
path: modules/customizing-templates/proc-viewing-the-results-of-software-component-creation.adoc
user: login: linfraze
body: It seems like this entire module should be a .Verification section in the software component creation procedure.
created_at: 2025-04-24T17:10:56Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,37 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. With this procedure, the scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} instance, go to the *Home > Catalog* page, and click *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: pabel-rh
body: The latest build says **Self-service** page, Lindsey... 
created_at: 2025-04-25T05:20:45Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,9 @@
+[id='con-about-software-templates']
+= About Software Templates
path: modules/customizing-templates/con-about-software-templates.adoc
user: login: themr0c
body: The content of this concept module is functionally replacing the assembly-configuring-templates introduction. Consider either removing the current assembly introduction, or replacing and expanding the assembly introduction with the content of this concept module.

Consider using "Software Templates" consistently in the entire section (assembly + included modules). For example the assembly title should be "Configuring Sotfware Templates" rather than "Configuring templates".
created_at: 2025-05-02T09:19:53Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,9 @@
+[id='con-about-software-templates']
+= About Software Templates
+
+Software Templates in {product} provide a streamlined way to create software components and publish them to different locations such as the {product} Software Catalog or Git repositories. Platform engineers create and maintain Software Templates in {product}.
+
+[role="_additional-resources"]
+.Additional resource
+
+* For tips on using better Software Templates, see link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better Backstage Software Templates].
path: modules/customizing-templates/con-about-software-templates.adoc
user: login: themr0c
body: Consider removing fluff

```suggestion
* See link:https://developers.redhat.com/articles/2025/03/17/10-tips-better-backstage-software-templates#[10 tips for better Backstage Software Templates].
```
created_at: 2025-05-02T09:20:32Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,46 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: themr0c
body: Remove this empty line as it is breaking the formatting.

```suggestion
```
created_at: 2025-05-02T09:21:28Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,46 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+The information that you enter for a software template is specific to that template.
+====
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: themr0c
body: Consider removing fluff. It is obvious.

```suggestion
```
created_at: 2025-05-02T09:23:01Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,46 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+To create a new software component, complete the following steps:
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+
++
+[NOTE]
+====
+The information that you enter for a software template is specific to that template.
+====
+
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is then sent to a task and none of the following steps are executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* If your software component is not successfully created, you can click on each section in the *Self-service* page to view the log information from the step that failed.
+
+* If your template is successfully created, you can view the component by clicking the following links on the success page:
+** *Source Repository*
+** *GitOps Repository*
+** *Open Component in Catalog*
+** *Open GitOps Resource in Catalog*
+
+* To view the software component that you have just created, click *Open Component in catalog*, or in your {product} instance, go to the *Home* page, and click *Catalog*.
+
+* To view the Source Code in your version control, click *Source Code Repository*.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: themr0c
body: Consider removing fluff. These steps are repeating substeps currently at lines 39 and 41.

```suggestion
```
created_at: 2025-05-02T09:28:12Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
path: modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
user: login: themr0c
body: Consider removing fluff (this is repeating the introduction sentence).

```suggestion
```
created_at: 2025-05-02T09:29:29Z
author_association: MEMBER
diff_hunk: @@ -1,23 +1,27 @@
 :_mod-docs-content-type: ASSEMBLY
 :context: configuring-templates
 [id="{context}"]
-= Configuring templates
+= About Software Templates
 
-Configure templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
+Software Templates in {product} provide a streamlined way to create software components and publish them to different locations such as the {product} Software Catalog or Git repositories. Platform engineers create and maintain Software Templates in {product}.
 
-A template is a form composed of different UI fields that is defined in a YAML file. Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
+You can configure Software Templates to create software components, and publish these components to different locations, such as the {product} software catalog, or Git repositories.
path: assemblies/assembly-configuring-templates.adoc
user: login: debsmita1
body: We publish the components in the Git repositories, and once published, we register them in the software catalog
created_at: 2025-05-05T12:16:16Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,33 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard Software Templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is then sent to a task and none of the following steps are executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* If your software component is not created successfully, you can click on each section in the *Self-service* page to view the log information from the step that failed.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: debsmita1
body: This is not correct
If the creation fails, the users can see the logs below to understand why it failed.
They also have an option to start over

![Screenshot 2025-05-14 at 12 20 23 PM](https://github.com/user-attachments/assets/e48d4351-9a99-4b13-8e8f-3e5965816bf3)

created_at: 2025-05-14T06:54:19Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,18 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-searching-and-filtering-software-templates_{context}"]
+= Searching and filtering Software Templates in your {product} instance
+
+You can search and filter for the Software Template that you want to use to create a new software component.
+
+.Procedure
+
+To search and filter for a Software Template, complete the following steps:
+
+. In the {product} navigation menu, click *Catalog* > *Self-service*.
+. Based on your requirement, select any option from any of the following drop-down menus:
+* *Categories*
+* *Owner*
path: modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc
user: login: debsmita1
body: Type the name of the template you are looking for in the Search box
If you are looking for templates in a certain category, you can use the Categories dropdown
![Screenshot 2025-05-14 at 12 27 45 PM](https://github.com/user-attachments/assets/bad55a21-3866-45bf-bbe9-2b88226e21e6)

![Screenshot 2025-05-14 at 12 27 19 PM](https://github.com/user-attachments/assets/84b4ef82-d7fe-4d11-a4c1-19515bb14825)

created_at: 2025-05-14T06:58:31Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,33 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard Software Templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: debsmita1
body: Not all templates will have this step. Is this why you have mentioned it as Optional ?
created_at: 2025-05-14T07:00:53Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,33 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard Software Templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: pabel-rh
body: Yes, Debsmita. I'll make that clearer.
created_at: 2025-05-14T08:52:29Z
author_association: MEMBER
diff_hunk: @@ -0,0 +1,40 @@
+// Module included in the following assemblies:
+//
+// * assemblies/assembly-configuring-templates.adoc
+
+:_mod-docs-content-type: PROCEDURE
+[id="proc-creating-a-new-software-component-using-templates_{context}"]
+= Creating a new software component using Software Templates
+
+You can create a new software component using the standard Software Templates that the platform engineers have created. The scaffolding process runs in your {product} instance.
+
+.Procedure
+
+. In your {product} navigation menu, click *Catalog* > *Self-service*.
+. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template.
+. Follow the wizard instructions as you enter the required details. You can choose parameters from a set of pre-defined options.
+* Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*. 
++
+[NOTE]
+====
+This step is available only for a few templates.
+====
+. In the *Review* step, verify the parameters you have entered and click *Create*.
++
+[NOTE]
+====
+* You can click *Cancel* to abort the software component creation during the template running step only if the current step supports the abort. The abort signal is then sent to a task and none of the following steps are executed. 
+* During the creation of the software component, click *Show Logs* to view the log information.
+====
+
+.Verification
+
+* If your software component is not created successfully, you can review the logs on the error page. To return to the *Self-service* page with your previously entered values, click *Start Over*.
path: modules/customizing-templates/proc-creating-a-new-software-component-using-templates.adoc
user: login: debsmita1
body: Starting over will take the user to the same template form with previously entered values
created_at: 2025-05-14T09:57:21Z
author_association: MEMBER

PR comments:
user: login: rhdh-bot
created_at: 2025-04-24T16:28:33Z
body: Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1098/ @ 05/14/25 10:05:48
author_association: COLLABORATOR
user: login: benwilcock
created_at: 2025-04-30T13:41:52Z
body: templates - I like the content but not the location. should it really be part of the setup guide? it seems to go off on a tangent. I expected this would be part of an end user focussed documentation collection, not part of the setup guide. Am I missing something here?
author_association: NONE
user: login: benwilcock
created_at: 2025-04-30T13:45:00Z
body: not sure about the title "configuring templates" as this is more like a general guide to the templates system.
author_association: NONE
user: login: pabel-rh
created_at: 2025-04-30T17:05:56Z
body: @benwilcock , sure!
I can discuss further with @Preeticp on where would be a better place to add this content.
author_association: MEMBER
user: login: linfraze
created_at: 2025-04-30T19:03:32Z
body: > not sure about the title "configuring templates" as this is more like a general guide to the templates system.

I agree. Perhaps simply _Software Templates_ is better.
author_association: MEMBER
user: login: linfraze
created_at: 2025-04-30T19:11:38Z
body: > templates - I like the content but not the location. should it really be part of the setup guide? it seems to go off on a tangent. I expected this would be part of an end user focussed documentation collection, not part of the setup guide. Am I missing something here?

One alternative is to change the title to Software Templates and make it a standalone title under the Configure category on the splash page. This title would cover both admin and developer use cases for Software Templates. 
author_association: MEMBER
user: login: pabel-rh
created_at: 2025-05-02T06:03:31Z
body: Thanks for your inputs, @linfraze ! :)
author_association: MEMBER
user: login: debsmita1
created_at: 2025-05-06T13:46:45Z
body: @pabel-rh Could you also update the Template Editor screenshots to align with RHDH 1.6 ?
author_association: MEMBER
user: login: pabel-rh
created_at: 2025-05-12T15:12:39Z
body: Ticket to review the Software Templates doc structure (will be taken up post GA):
https://issues.redhat.com/browse/RHIDP-7487
author_association: MEMBER
user: login: pabel-rh
created_at: 2025-05-13T08:29:20Z
body: @debsmita1 , regarding the rest of the Template Editor changes, we have a TestDay label ticket already created for it in RHIDP-7436. We will make those changes in that ticket. 
For this ticket, we will focus on the new content. :) 
But new screenshot is updated!
author_association: MEMBER
user: login: hmanwani-rh
created_at: 2025-05-14T10:44:02Z
body: /cherry-pick release-1.6
author_association: MEMBER
user: login: openshift-cherrypick-robot
created_at: 2025-05-14T10:44:40Z
body: @hmanwani-rh: new pull request created: #1164

<details>

In response to [this](https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/pull/1098#issuecomment-2879712295):

>/cherry-pick release-1.6


Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md).  If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes-sigs/prow](https://github.com/kubernetes-sigs/prow/issues/new?title=Prow%20issue:) repository.
</details>
author_association: CONTRIBUTOR