You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/customizing-templates/proc-adding-templates.adoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,18 +4,18 @@
4
4
5
5
:_mod-docs-content-type: PROCEDURE
6
6
[id="proc-adding-templates_{context}"]
7
-
= Importing an existing template to {product}
7
+
= Importing an existing Software Template to {product}
8
8
9
-
You can add an existing template to your {product} instance by using the Catalog Processor.
9
+
You can add an existing Software Template to your {product} instance by using the Catalog Processor.
10
10
11
11
.Prerequisites
12
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.
13
+
* You have created a directory or repository that contains at least one Software Template YAML file.
14
+
* If you want to use a Software Template that is stored in a repository such as GitHub or GitLab, you must configure a {product} integration for your provider.
15
15
16
16
.Procedure
17
17
18
-
* 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:
18
+
* 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 Software Template that you want to add, as shown in the following example:
.. On the *Template Editor* page, select the `templates.yaml` file.
42
42
.. On the *Fill in some steps* tab, enter text into the required fields and click *Next*.
43
43
.. On the *Repository Location* tab, enter text into the required fields and click *Review*.
44
-
.. 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>>.
44
+
.. 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>>.
45
45
.. Review the information for accuracy, then click *Create*.
46
46
47
47
.Verification
48
48
49
49
. Click the *Catalog* tab in the navigation panel.
50
50
. In the *Kind* drop-down menu, select *Template*.
51
-
. Confirm that your template is shown in the list of existing templates.
51
+
. Confirm that your Software Template is shown in the list of existing templates.
Copy file name to clipboardExpand all lines: modules/customizing-templates/ref-creating-templates.adoc
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,9 +4,9 @@
4
4
5
5
:_mod-docs-content-type: REFERENCE
6
6
[id="ref-creating-templates_{context}"]
7
-
= Creating a template as a YAML file
7
+
= Creating a Software Template as a YAML file
8
8
9
-
You can create a template by defining a `Template` object as a YAML file.
9
+
You can create a Software Template by defining a `Template` object as a YAML file.
10
10
11
11
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.
<2> Specify a title for the template. This is the title that is visible on the template tile in the *Create...* view.
61
-
<3> Specify a description for the template. This is the description that is visible on the template tile in the *Create...* view.
62
-
<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.
59
+
<1> Specify a name for the Software Template.
60
+
<2> Specify a title for the Software Template. This is the title that is visible on the Software Template tile in the *Create...* view.
61
+
<3> Specify a description for the Software Template. This is the description that is visible on the Software Template tile in the *Create...* view.
62
+
<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.
63
63
<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.
64
64
+
65
65
The following values are common for this field:
@@ -69,8 +69,8 @@ The following values are common for this field:
69
69
`website`:: A website.
70
70
`library`:: A software library, such as an npm module or a Java library.
71
71
--
72
-
<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.
72
+
<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.
73
73
<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`.
74
-
<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.
74
+
<8> Use the `output` section to specify the structure of output data that is created when the Software 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 Software Template.
75
75
<9> Provides a reference or URL to the repository associated with the generated component.
76
76
<10> Provides a reference or URL that allows users to open the generated component in a catalog or directory where various components are listed.
0 commit comments