Skip to content

Commit 3945088

Browse files
author
GitHub Actions
committed
New updates
Update the disconnected environment Apply suggestions Apply suggestions RHIDP-8630: Added notification during software template version update (redhat-developer#1431) * Added notification during software template version update * Incorporated Diana's comments * Incorporated Judy's comments RHIDP-9010: AEM-related changes (redhat-developer#1426) * AEM-related changes * Minor change Judy's comment * Incorporated Fabrice's comments * Incorporated Judy's comments * Incorporated Fabrice's final comments RHIDP-8641: Building and Deploying Serverless Workflows (redhat-developer#1416) * Minor fix Building and Deploying Serverless Workflows Building and Deploying Serverless Workflows Building and Deploying Serverless Workflows Building and Deploying Serverless Workflows Building and Deploying Serverless Workflows Building and Deploying Serverless Workflows Apply Piotr and Yona's suggestions Make adjustments Apply technical reviewers suggestions Update link Update the build and deploy section Minor fix Building and Deploying Serverless Workflows * Minor update * Apply Priyanka's suggestions * Apply Priyanka's suggestions * Apply Priyanka's suggestions --------- Co-authored-by: GitHub Actions <[email protected]> Apply suggestions Apply suggestions Update the disconnected environment
1 parent cc2cc43 commit 3945088

File tree

45 files changed

+1151
-218
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+1151
-218
lines changed

artifacts/attributes.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@
151151
:observability-category-link: {product-docs-link}/#Observability
152152
:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
153153
:odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version}
154+
:orchestrator-book-link: {product-docs-link}/html-single/orchestrator_in_red_hat_developer_hub/index
155+
:orchestrator-book-title: Orchestrator in {product}
154156
:osd-docs-link: link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-version}
155157
:release-notes-book-link: {product-docs-link}/html-single/red_hat_developer_hub_release_notes/index
156158
:release-notes-book-title: {product} release notes
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
ifdef::context[]
4+
[id="assembly-building-and-deploying-serverless-workflows"]
5+
endif::[]
6+
:context: orchestrator-rhdh
7+
= Build and deploy serverless workflows
8+
9+
To deploy a workflow and make it available in the Orchestrator plugin, follow these main steps:
10+
11+
* Building workflow images
12+
* Generating workflow manifests
13+
* Deploying workflows to a cluster
14+
15+
This process moves the workflow from your local machine to deployment on a cluster.
16+
17+
// why build workflow images
18+
include::modules/orchestrator/con-benefits-of-workflow-images.adoc[leveloffset=+1]
19+
20+
// project structure
21+
include::modules/orchestrator/con-project-structure-overview.adoc[leveloffset=+2]
22+
23+
// creating and running workflows locally
24+
include::modules/orchestrator/proc-creating-and-running-workflows.adoc[leveloffset=+2]
25+
26+
// building locally and generating artifacts
27+
include::modules/orchestrator/proc-building-locally.adoc[leveloffset=+1]
28+
29+
// the script and its uses
30+
include::modules/orchestrator/con-build-sh-script-and-its-uses.adoc[leveloffset=+2]
31+
32+
// environment variables supported by the script
33+
include::modules/orchestrator/con-environment-variables-supported-by-the-build-script.adoc[leveloffset=+2]
34+
35+
// required tools
36+
include::modules/orchestrator/con-required-tools.adoc[leveloffset=+2]
37+
38+
// building the 01_basic workflow
39+
include::modules/orchestrator/proc-building-the-01-basic-workflow.adoc[leveloffset=+2]
40+
41+
// generated workflow manifests
42+
include::modules/orchestrator/con-generated-workflow-manifests.adoc[leveloffset=+1]
43+
44+
// deploy workflows on a cluster
45+
include::modules/orchestrator/proc-deploying-workflows-on-a-cluster.adoc[leveloffset=+1]

assemblies/assembly-configuring-templates.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ include::modules/customizing-templates/proc-creating-a-new-software-component-us
1919
include::modules/customizing-templates/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]
2020
include::modules/customizing-templates/proc-adding-templates.adoc[leveloffset=+1]
2121
include::modules/customizing-templates/proc-versioning-software-templates.adoc[leveloffset=+1]
22+
include::modules/customizing-templates/proc-enabling-software-template-version-update-notifications.adoc[leveloffset=+1]
2223

2324
[role="_additional-resources"]
2425
.Additional resources

assemblies/assembly-configuring-the-quickstarts.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,6 @@ include::modules/configuring-the-quickstarts/con-about-quickstarts.adoc[leveloff
88

99
include::modules/configuring-the-quickstarts/proc-customize-rhdh-quickstart.adoc[leveloffset=+1]
1010

11+
include::modules/configuring-the-quickstarts/proc-disabling-rhdh-quickstart.adoc[leveloffset=+2]
12+
1113
include::modules/configuring-the-quickstarts/proc-starting-and-completing-modules-in-quickstarts.adoc[leveloffset=+1]

assemblies/assembly-customizing-the-appearance.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,15 @@
44
[id="{context}"]
55
= Customizing {product} appearance
66

7+
By modifying the visual aspects of the interface, organizations can align {product} with their branding guidelines and improve the overall user experience.
8+
79
The following default theme configurations are available for {product}:
810

911
The {product} theme:: Default theme configurations to make your developer portal look like a standard {product} instance. For more information, see xref:ref-customize-rhdh-default-rhdh_{context}[]
1012

1113
The Backstage theme:: Default theme configurations to make your developer portal look like a standard Backstage instance. For more information, see xref:ref-customize-rhdh-default-backstage_{context}[]
1214

13-
You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the `app-config-rhdh.yaml` file, you can customize common theme components, including the following:
15+
You can change or disable particular parameters in a default theme or create a fully customized theme by modifying the `app-config-rhdh.yaml` file. From the `app-config-rhdh.yaml` file, you can customize common theme components, including the following components:
1416

1517
* Company name and logo
1618
* Font color, size, and style of text in paragraphs, headings, headers, and buttons
@@ -26,7 +28,7 @@ include::modules/customizing-the-appearance/proc-customize-rhdh-theme-mode.adoc[
2628
include::modules/customizing-the-appearance/proc-customize-rhdh-branding-logo.adoc[leveloffset=+1]
2729

2830

29-
include::modules/customizing-the-appearance/con-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
31+
include::modules/customizing-the-appearance/con-about-rhdh-sidebar-menuitems.adoc[leveloffset=+1]
3032

3133
include::modules/customizing-the-appearance/proc-customize-rhdh-sidebar-menuitems.adoc[leveloffset=+2]
3234

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment_{context}"]
4+
= Installing Orchestrator plugin in an air-gapped environment
5+
6+
You can configure {product} ({product-very-short}) with Orchestrator plugin in an air-gapped environment by using either the Operator or Helm chart.
7+
8+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator.adoc[leveloffset=+1]
9+
10+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart.adoc[leveloffset=+1]

modules/configuring-a-floating-action-button/proc-configuring-floating-action-button-as-a-dynamic-plugin.adoc

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ To configure a floating action button as a dynamic plugin, complete any of the f
1414

1515
* Specify the `global.floatingactionbutton/config` mount point in your `app-config-dynamic.yaml` file. For example:
1616
+
17-
.Example of a bulk-import plugin as a floating action button
1817
[source,yaml]
1918
----
2019
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
@@ -26,10 +25,10 @@ To configure a floating action button as a dynamic plugin, complete any of the f
2625
# Start of the floating action button configuration
2726
mountPoints:
2827
- mountPoint: global.floatingactionbutton/config
29-
importName: BulkImportPage # <1>
28+
importName: BulkImportPage
3029
config:
3130
slot: 'page-end'
32-
icon: <svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#e8eaed"><g><rect fill="none" height="24" width="24"/></g><g><path d="M11,7L9.6,8.4l2.6,2.6H2v2h10.2l-2.6,2.6L11,17l5-5L11,7z M20,19h-8v2h8c1.1,0,2-0.9,2-2V5c0-1.1-0.9-2-2-2h-8v2h8V19z"/></g></svg> # <2>
31+
icon: <svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#e8eaed"><g><rect fill="none" height="24" width="24"/></g><g><path d="M11,7L9.6,8.4l2.6,2.6H2v2h10.2l-2.6,2.6L11,17l5-5L11,7z M20,19h-8v2h8c1.1,0,2-0.9,2-2V5c0-1.1-0.9-2-2-2h-8v2h8V19z"/></g></svg>
3332
label: 'Bulk import'
3433
toolTip: 'Register multiple repositories in bulk'
3534
to: /bulk-import/repositories
@@ -44,12 +43,11 @@ To configure a floating action button as a dynamic plugin, complete any of the f
4443
icon: bulkImportIcon
4544
text: Bulk import
4645
----
47-
<1> (Required) The import name with an associated component to the mount point.
48-
<2> Use the `svg` value to display a black BulkImportPage icon.
46+
`frontend:mountPoints:importName`:: (Required) The import name with an associated component to the mount point.
47+
`frontend:mountPoints:importName:icon`:: Use the `svg` value to display a black `BulkImportPage` icon.
4948

5049
* To configure an action as a floating action button that opens an external link, specify the `global.floatingactionbutton/config` mount point in your `dynamic-plugins.yaml` file within the `backstage-plugin-global-floating-action-button` plugin. For example:
5150
+
52-
.Example of a floating action button that opens GitHub
5351
[source,yaml]
5452
----
5553
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-global-floating-action-button
@@ -62,9 +60,9 @@ To configure a floating action button as a dynamic plugin, complete any of the f
6260
- mountPoint: application/listener
6361
importName: DynamicGlobalFloatingActionButton
6462
- mountPoint: global.floatingactionbutton/config
65-
importName: NullComponent # <1>
63+
importName: NullComponent
6664
config:
67-
icon: '<svg viewBox="0 0 250 300" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMidYMid"><path d="M200.134 0l55.555 117.514-55.555 117.518h-47.295l55.555-117.518L152.84 0h47.295zM110.08 99.836l20.056-38.092-2.29-8.868L102.847 0H55.552l48.647 102.898 5.881-3.062zm17.766 74.433l-17.333-39.034-6.314-3.101-48.647 102.898h47.295l25-52.88v-7.883z" fill="#40B4E5"/><path d="M152.842 235.032L97.287 117.514 152.842 0h47.295l-55.555 117.514 55.555 117.518h-47.295zm-97.287 0L0 117.514 55.555 0h47.296L47.295 117.514l55.556 117.518H55.555z" fill="#003764"/></svg>' # <2>
65+
icon: '<svg viewBox="0 0 250 300" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMidYMid"><path d="M200.134 0l55.555 117.514-55.555 117.518h-47.295l55.555-117.518L152.84 0h47.295zM110.08 99.836l20.056-38.092-2.29-8.868L102.847 0H55.552l48.647 102.898 5.881-3.062zm17.766 74.433l-17.333-39.034-6.314-3.101-48.647 102.898h47.295l25-52.88v-7.883z" fill="#40B4E5"/><path d="M152.842 235.032L97.287 117.514 152.842 0h47.295l-55.555 117.514 55.555 117.518h-47.295zm-97.287 0L0 117.514 55.555 0h47.296L47.295 117.514l55.556 117.518H55.555z" fill="#003764"/></svg>'
6866
label: 'Quay'
6967
showLabel: true
7068
toolTip: 'Quay'
@@ -77,12 +75,11 @@ To configure a floating action button as a dynamic plugin, complete any of the f
7775
toolTip: 'Github'
7876
to: https://github.com/redhat-developer/rhdh-plugins
7977
----
80-
<1> (Required) The import name with an associated component to the mount point.
81-
<2> Use the `svg` value to display the `Quay` icon.
78+
`frontend:mountPoints:importName`:: Enter the import name with an associated component to the mount point.
79+
`frontend:mountPoints:importName:icon`:: (Optional) Enter the icon in Scalable Vector Graphics (SVG) format to display the `Quay` icon.
8280

8381
* To configure a floating action button that contains a submenu, define the `global.floatingactionbutton/config` mount point in the same `slot` field in your `dynamic-plugins.yaml` file for multiple actions. The default slot is `page-end` when not specified. For example:
8482
+
85-
.Example of a floating action button with submenu actions
8683
[source,yaml]
8784
----
8885
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
@@ -94,7 +91,7 @@ To configure a floating action button as a dynamic plugin, complete any of the f
9491
# Start of fab config
9592
mountPoints:
9693
- mountPoint: global.floatingactionbutton/config
97-
importName: BulkImportPage # <1>
94+
importName: BulkImportPage
9895
config:
9996
slot: 'page-end'
10097
icon: <svg xmlns="http://www.w3.org/2000/svg" enable-background="new 0 0 24 24" height="24px" viewBox="0 0 24 24" width="24px" fill="#e8eaed"><g><rect fill="none" height="24" width="24"/></g><g><path d="M11,7L9.6,8.4l2.6,2.6H2v2h10.2l-2.6,2.6L11,17l5-5L11,7z M20,19h-8v2h8c1.1,0,2-0.9,2-2V5c0-1.1-0.9-2-2-2h-8v2h8V19z"/></g></svg>
@@ -122,26 +119,25 @@ To configure a floating action button as a dynamic plugin, complete any of the f
122119
- mountPoint: application/listener
123120
importName: DynamicGlobalFloatingActionButton
124121
- mountPoint: global.floatingactionbutton/config
125-
importName: NullComponent # <1>
122+
importName: NullComponent
126123
config:
127124
icon: github
128125
label: 'Git'
129126
toolTip: 'Github'
130127
to: https://github.com/redhat-developer/rhdh-plugins
131128
- mountPoint: global.floatingactionbutton/config
132-
importName: NullComponent # <1>
129+
importName: NullComponent
133130
config:
134131
icon: '<svg viewBox="0 0 250 300" xmlns="http://www.w3.org/2000/svg" preserveAspectRatio="xMidYMid"><path d="M200.134 0l55.555 117.514-55.555 117.518h-47.295l55.555-117.518L152.84 0h47.295zM110.08 99.836l20.056-38.092-2.29-8.868L102.847 0H55.552l48.647 102.898 5.881-3.062zm17.766 74.433l-17.333-39.034-6.314-3.101-48.647 102.898h47.295l25-52.88v-7.883z" fill="#40B4E5"/><path d="M152.842 235.032L97.287 117.514 152.842 0h47.295l-55.555 117.514 55.555 117.518h-47.295zm-97.287 0L0 117.514 55.555 0h47.296L47.295 117.514l55.556 117.518H55.555z" fill="#003764"/></svg>'
135132
label: 'Quay'
136133
showLabel: true
137134
toolTip: 'Quay'
138135
to: 'https://quay.io'
139136
----
140-
<1> (Required) The import name with an associated component to the mount point.
137+
`frontend:mountPoints:importName`:: (Required) The import name with an associated component to the mount point.
141138

142139
* To configure a floating action button to display only on specific pages, configure the `global.floatingactionbutton/config` mount point in the `backstage-plugin-global-floating-action-button` plugin and set the `visibleOnPaths` property as shown in the following example:
143140
+
144-
.Example of a floating action button to display specific pages
145141
[source,yaml]
146142
----
147143
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
@@ -172,11 +168,10 @@ To configure a floating action button as a dynamic plugin, complete any of the f
172168
icon: bulkImportIcon
173169
text: Bulk import
174170
----
175-
<1> (Required) The import name with an associated component to the mount point.
171+
`frontend:mountPoints:importName`:: Enter the import name with an associated component to the mount point.
176172

177173
* To hide a floating action button on specific pages, configure the `global.floatingactionbutton/config` mount point in the `backstage-plugin-global-floating-action-button` plugin and set the `excludeOnPaths` property as shown in the following example:
178174
+
179-
.Example of a floating action button to hide specific pages
180175
[source,yaml]
181176
----
182177
- package: ./dynamic-plugins/dist/red-hat-developer-hub-backstage-plugin-bulk-import
@@ -207,4 +202,4 @@ To configure a floating action button as a dynamic plugin, complete any of the f
207202
icon: bulkImportIcon
208203
text: Bulk import
209204
----
210-
<1> (Required) The import name with an associated component to the mount point.
205+
`frontend:mountPoints:importName`:: Enter the import name with an associated component to the mount point.

modules/configuring-the-global-header/con-quicklinks-and-starred-items-in-global-header.adoc

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ The *Quicklinks* matrix, organized by sections (for example, Documentation or De
99

1010
The default configuration includes the following components:
1111

12-
*StarredDropdown*: Displays the *Starred Items* menu in the global header by default, as shown in the following configuration:
13-
12+
`StarredDropdown`:: Display the *Starred Items* menu in the global header by default, as shown in the following configuration:
13+
+
1414
[source,yaml]
1515
----
1616
# Group: Global Header
@@ -21,8 +21,8 @@ The default configuration includes the following components:
2121
priority: 85
2222
----
2323

24-
*ApplicationLauncherDropdown*: Provides the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
25-
24+
`ApplicationLauncherDropdown`:: Provide the *Quicklinks* matrix (application launcher) by default, as shown in the following configuration:
25+
+
2626
[source,yaml]
2727
----
2828
# Group: Global Header
@@ -33,8 +33,8 @@ The default configuration includes the following components:
3333
priority: 82
3434
----
3535

36-
*MenuItemLink entries*: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
37-
36+
`MenuItemLink entries`:: Define sections, titles, icons, and links within the *Quicklinks* matrix. The default configuration includes links to the {product-short} documentation and an {product-very-short} Local, as shown in the following configurations:
37+
+
3838
[source,yaml,subs="+attributes"]
3939
----
4040
- mountPoint: global.header/application-launcher
@@ -61,8 +61,4 @@ The default configuration includes the following components:
6161
[NOTE]
6262
====
6363
When upgrading from previous versions, the installer does not overwrite your existing `dynamic-plugins.yaml` configuration. If you had not configured *Starred Items* or *Quicklinks* previously, they remain disabled after the upgrade and must be manually enabled.
64-
====
65-
66-
67-
68-
64+
====

modules/configuring-the-global-header/proc-configuring-logo-in-the-global-header.adoc

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,12 @@ This component supports the following props, which are provided through configur
1010
* `logo`: The base64 encoded logo image.
1111
* `to`: The redirect path for when users click the logo is '/catalog'.
1212
* `width`: The logo width is optional and defaults to 150 px.
13-
* `height`: The logo height is optional and defaults to 40px.
13+
* `height`: The logo height is optional and defaults to 40 px.
1414

1515
.Procedure
1616

1717
. To display a custom company logo in the global header, update the configuration with a mount point for `CompanyLogo`:
1818
+
19-
.Example: Configuring company logo
20-
+
2119
[source,yaml,subs="+attributes,+quotes"]
2220
----
2321
# ...rest of the global header configuration
@@ -50,8 +48,6 @@ red-hat-developer-hub.backstage-plugin-global-header:
5048

5149
. (Optional) If you do not provide `logo` props to the `CompanyLogo` component, the component instead uses values defined under `app.branding` in your `{my-app-config-file}` file. You can configure the `CompanyLogo` as shown in the following configuration:
5250
+
53-
.Example: Fallback configuration
54-
+
5551
[source,yaml,subs="+attributes,+quotes"]
5652
----
5753
app:

0 commit comments

Comments
 (0)