Skip to content

NO-JIRA: Fix typos in RHDH Quickstarts #1010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions quickstarts/rhdh-installation-via-helm.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ metadata:
capability.openshift.io/name: Console
spec:
displayName: Install Red Hat Developer Hub (RHDH) using Helm Chart
description: Install RHDH, a enterprise-grade, open developer platform for building developer portals, build on Backstage.
description: Install RHDH, an enterprise-grade, open developer platform for building developer portals, built on Backstage.
durationMinutes: 30
tags:
- rhdh
Expand Down Expand Up @@ -99,7 +99,7 @@ spec:
* A **catalog** of all your services, components, and more.
* **Software Templates** provide your developers an easy way to set up new projects with best practices.
* Preinstalled with **additional plugins**.
* Your developer portal is **extendable with plugins** from Backstage.
* Your developer portal is **extensible with plugins** from Backstage.

This **Red Hat Developer Hub Helm Chart** has some additional features enabled by default:

Expand All @@ -114,7 +114,7 @@ spec:
1. If present, click on the [perspective switcher]{{highlight qs-perspective-switcher}} at the top of the navigation and select **Administrator**.
2. In the main navigation menu, select [Helm]{{highlight qs-admin-nav-helm}} and select **Releases**.
3. If needed, switch or create a new project from the **Project dropdown**.
4. On the **Helm Releases** page, click **Create Helm Release** button.
4. On the **Helm Releases** page, click the **Create Helm Release** button.
5. Search for **Red Hat Developer Hub**
6. Select the card **Red Hat Developer Hub, Provided by Red Hat**, and press **Create** to open a page to configure the Helm Chart.
7. **Optional:** Change the default configuration via the form (click on Root Schema to expand the configuration) or YAML based on your needs.
Expand Down Expand Up @@ -194,7 +194,7 @@ spec:
2. Click on the URL decorator in the top-right corner of the "developer-hub" Deployment to open your Red Hat Developer Hub instance.
3. Verify that the correct URL is used and the Red Hat Developer Hub installation works fine.
failedTaskHelp: |-
Doublecheck your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.
Double-check your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Double-check your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.
Double check your Helm Chart hostname and TLS configuration, and if needed, the external DNS configuration.

Just needs a space, no hyphen.

summary:
success: You have upgraded Red Hat Developer Hub!
failed: Try the steps again.
Expand All @@ -220,7 +220,7 @@ spec:
text: Red Hat Developer Hub
```{{copy}}

3. Click **Create**.
4. Click **Create**.
review:
instructions: |-
#### To verify that the application menu link is shown
Expand All @@ -229,9 +229,9 @@ spec:
2. Click on the Application launcher icon and check if your application menu item is shown.
3. Verify that it opens your RHDH instance.
failedTaskHelp: |-
Doublecheck your `ConsoleLink` resource or try to reload the OpenShift Console.
Double-check your `ConsoleLink` resource or try to reload the OpenShift Console.
summary:
success: You have upgraded your RHDH instance!
success: You have added your Red Hat Developer Hub instance to the OpenShift Console menu!
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
success: You have added your Red Hat Developer Hub instance to the OpenShift Console menu!
success: You have added your instance of Red Hat Developer Hub to the OpenShift Console menu!

Just a small reword suggestion

failed: Try the steps again.
conclusion: |
Your Red Hat Developer Hub installation is deployed and ready.
16 changes: 8 additions & 8 deletions quickstarts/rhdh-installation-via-operator.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ metadata:
capability.openshift.io/name: Console
spec:
displayName: Install Red Hat Developer Hub (RHDH) using the Operator
description: Install RHDH, a enterprise-grade, open developer platform for building developer portals, build on Backstage.
description: Install RHDH, an enterprise-grade, open developer platform for building developer portals, built on Backstage.
durationMinutes: 30
tags:
- rhdh
Expand Down Expand Up @@ -99,7 +99,7 @@ spec:
* A **catalog** of all your services, components, and more.
* **Software Templates** provide your developers an easy way to set up new projects with best practices.
* Preinstalled with **additional plugins**.
* Your developer portal is **extendable with plugins** from Backstage.
* Your developer portal is **extensible with plugins** from Backstage.

This **Red Hat Developer Hub Operator** has some additional features enabled by default:

Expand All @@ -115,14 +115,14 @@ spec:
2. In the Administrator perspective, go to the **OperatorHub** page from the [Operators]{{highlight qs-nav-operators}} section of the navigation.
3. Search for **Red Hat Developer Hub**
4. Select the card **Red Hat Developer Hub** with the **Red Hat** badge and press **Install** to open a page to install the Operator.
5. **Optional:** Choice the correct version, update strategy, and if this Operator should be available for all namespaces or just a specific namespace.
5. **Optional:** Choose the correct version, update strategy, and whether this Operator should be available for all namespaces or just a specific namespace.
6. Press **Create** again to install the Red Hat Developer Hub Operator.

> <small>
> For enhanced security, you should deploy the Red Hat Developer Hub Operator in a dedicated default namespace such as `rhdh-operator`.
> The cluster administrator can restrict access to the Operator resources through role bindings or cluster role bindings.
> You can choose to deploy the Operator in the `openshift-operators` namespace instead,
> but, note the Red Hat Developer Hub Operator shares the namespace with other Operators.
> but, note the Red Hat Developer Hub Operator then shares the namespace with other Operators.
> Any users who can create workloads in that namespace can get their privileges escalated from the Operator service account.
> </small>
review:
Expand Down Expand Up @@ -294,13 +294,13 @@ spec:
1. In the **Administrator** perspective you should now see a RHDH "backstage-my-rhdh” Deployment under Workloads > Deployments,
or in the [Topology]{{highlight qs-nav-topology}} view of the **Developer** perspective.
2. It might take a moment for your Deployment to update. Check that the status of the Pods changes to "Running".
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.
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.
failedTaskHelp: |-
Open the **Deployment details** page and check the Pod status or the Pod log to investigate underlying issues.
summary:
success: You have installed RHDH!
failed: Try the steps again.
- title: "Add your Red Hat Developer Hub insance to the OpenShift Console Application menu"
- title: "Add your Red Hat Developer Hub instance to the OpenShift Console Application menu"
description: |-
To add a new link to the application menu, you can create a `ConsoleLink` resource on your cluster.

Expand Down Expand Up @@ -331,9 +331,9 @@ spec:
2. Click the Application launcher icon to check if your application menu item is shown.
3. Verify that it opens your RHDH instance.
failedTaskHelp: |-
Doublecheck your `ConsoleLink` resource or try to reload the OpenShift Console.
Double-check your `ConsoleLink` resource or try to reload the OpenShift Console.
summary:
success: You have upgraded your RHDH instance!
success: You have added your Red Hat Developer Hub instance to the OpenShift Console menu!
failed: Try the steps again.
conclusion: |
Your Red Hat Developer Hub installation is deployed and ready.