Skip to content

Commit 9aa65fe

Browse files
rm3lopayne1
andauthored
NO-JIRA: Fix typos in RHDH Quickstarts (#1010)
* fix: fix typos in RHDH Quickstarts * Apply suggestions from code review Co-authored-by: Olivia Payne <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Olivia Payne <[email protected]>
1 parent 8565552 commit 9aa65fe

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

quickstarts/rhdh-installation-via-helm.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ metadata:
1010
capability.openshift.io/name: Console
1111
spec:
1212
displayName: Install Red Hat Developer Hub (RHDH) using Helm Chart
13-
description: Install RHDH, a enterprise-grade, open developer platform for building developer portals, build on Backstage.
13+
description: Install RHDH, an enterprise-grade, open developer platform for building developer portals, built on Backstage.
1414
durationMinutes: 30
1515
tags:
1616
- rhdh
@@ -99,7 +99,7 @@ spec:
9999
* A **catalog** of all your services, components, and more.
100100
* **Software Templates** provide your developers an easy way to set up new projects with best practices.
101101
* Preinstalled with **additional plugins**.
102-
* Your developer portal is **extendable with plugins** from Backstage.
102+
* Your developer portal is **extensible with plugins** from Backstage.
103103
104104
This **Red Hat Developer Hub Helm Chart** has some additional features enabled by default:
105105
@@ -114,7 +114,7 @@ spec:
114114
1. If present, click on the [perspective switcher]{{highlight qs-perspective-switcher}} at the top of the navigation and select **Administrator**.
115115
2. In the main navigation menu, select [Helm]{{highlight qs-admin-nav-helm}} and select **Releases**.
116116
3. If needed, switch or create a new project from the **Project dropdown**.
117-
4. On the **Helm Releases** page, click **Create Helm Release** button.
117+
4. On the **Helm Releases** page, click the **Create Helm Release** button.
118118
5. Search for **Red Hat Developer Hub**
119119
6. Select the card **Red Hat Developer Hub, Provided by Red Hat**, and press **Create** to open a page to configure the Helm Chart.
120120
7. **Optional:** Change the default configuration via the form (click on Root Schema to expand the configuration) or YAML based on your needs.
@@ -194,7 +194,7 @@ spec:
194194
2. Click on the URL decorator in the top-right corner of the "developer-hub" Deployment to open your Red Hat Developer Hub instance.
195195
3. Verify that the correct URL is used and the Red Hat Developer Hub installation works fine.
196196
failedTaskHelp: |-
197-
Doublecheck your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.
197+
Double check your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.
198198
summary:
199199
success: You have upgraded Red Hat Developer Hub!
200200
failed: Try the steps again.
@@ -220,7 +220,7 @@ spec:
220220
text: Red Hat Developer Hub
221221
```{{copy}}
222222
223-
3. Click **Create**.
223+
4. Click **Create**.
224224
review:
225225
instructions: |-
226226
#### To verify that the application menu link is shown
@@ -229,9 +229,9 @@ spec:
229229
2. Click on the Application launcher icon and check if your application menu item is shown.
230230
3. Verify that it opens your RHDH instance.
231231
failedTaskHelp: |-
232-
Doublecheck your `ConsoleLink` resource or try to reload the OpenShift Console.
232+
Double check your `ConsoleLink` resource or try to reload the OpenShift Console.
233233
summary:
234-
success: You have upgraded your RHDH instance!
234+
success: You have added your instance of Red Hat Developer Hub to the OpenShift Console menu!
235235
failed: Try the steps again.
236236
conclusion: |
237237
Your Red Hat Developer Hub installation is deployed and ready.

quickstarts/rhdh-installation-via-operator.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ metadata:
1010
capability.openshift.io/name: Console
1111
spec:
1212
displayName: Install Red Hat Developer Hub (RHDH) using the Operator
13-
description: Install RHDH, a enterprise-grade, open developer platform for building developer portals, build on Backstage.
13+
description: Install RHDH, an enterprise-grade, open developer platform for building developer portals, built on Backstage.
1414
durationMinutes: 30
1515
tags:
1616
- rhdh
@@ -99,7 +99,7 @@ spec:
9999
* A **catalog** of all your services, components, and more.
100100
* **Software Templates** provide your developers an easy way to set up new projects with best practices.
101101
* Preinstalled with **additional plugins**.
102-
* Your developer portal is **extendable with plugins** from Backstage.
102+
* Your developer portal is **extensible with plugins** from Backstage.
103103
104104
This **Red Hat Developer Hub Operator** has some additional features enabled by default:
105105
@@ -115,14 +115,14 @@ spec:
115115
2. In the Administrator perspective, go to the **OperatorHub** page from the [Operators]{{highlight qs-nav-operators}} section of the navigation.
116116
3. Search for **Red Hat Developer Hub**
117117
4. Select the card **Red Hat Developer Hub** with the **Red Hat** badge and press **Install** to open a page to install the Operator.
118-
5. **Optional:** Choice the correct version, update strategy, and if this Operator should be available for all namespaces or just a specific namespace.
118+
5. **Optional:** Choose the correct version, update strategy, and whether this Operator should be available for all namespaces or just a specific namespace.
119119
6. Press **Create** again to install the Red Hat Developer Hub Operator.
120120
121121
> <small>
122122
> For enhanced security, you should deploy the Red Hat Developer Hub Operator in a dedicated default namespace such as `rhdh-operator`.
123123
> The cluster administrator can restrict access to the Operator resources through role bindings or cluster role bindings.
124124
> You can choose to deploy the Operator in the `openshift-operators` namespace instead,
125-
> but, note the Red Hat Developer Hub Operator shares the namespace with other Operators.
125+
> but, note the Red Hat Developer Hub Operator then shares the namespace with other Operators.
126126
> Any users who can create workloads in that namespace can get their privileges escalated from the Operator service account.
127127
> </small>
128128
review:
@@ -294,13 +294,13 @@ spec:
294294
1. In the **Administrator** perspective you should now see a RHDH "backstage-my-rhdh” Deployment under Workloads > Deployments,
295295
or in the [Topology]{{highlight qs-nav-topology}} view of the **Developer** perspective.
296296
2. It might take a moment for your Deployment to update. Check that the status of the Pods changes to "Running".
297-
3. You should see a RHDH instance that let you select a sign-in method and your updated RHDH title in your browser tab and organization name on the catalog page.
297+
3. You should see a RHDH instance that lets you select a sign-in method and your updated RHDH title in your browser tab and organization name on the catalog page.
298298
failedTaskHelp: |-
299299
Open the **Deployment details** page and check the Pod status or the Pod log to investigate underlying issues.
300300
summary:
301301
success: You have installed RHDH!
302302
failed: Try the steps again.
303-
- title: "Add your Red Hat Developer Hub insance to the OpenShift Console Application menu"
303+
- title: "Add your Red Hat Developer Hub instance to the OpenShift Console Application menu"
304304
description: |-
305305
To add a new link to the application menu, you can create a `ConsoleLink` resource on your cluster.
306306
@@ -331,9 +331,9 @@ spec:
331331
2. Click the Application launcher icon to check if your application menu item is shown.
332332
3. Verify that it opens your RHDH instance.
333333
failedTaskHelp: |-
334-
Doublecheck your `ConsoleLink` resource or try to reload the OpenShift Console.
334+
Double check your `ConsoleLink` resource or try to reload the OpenShift Console.
335335
summary:
336-
success: You have upgraded your RHDH instance!
336+
success: You have added your Red Hat Developer Hub instance to the OpenShift Console menu!
337337
failed: Try the steps again.
338338
conclusion: |
339339
Your Red Hat Developer Hub installation is deployed and ready.

0 commit comments

Comments
 (0)