Procedure

1. Navigate to the RHDH URL provided by your administrator.

2. On the login page, select the appropriate authentication method for your project:

   • Enterprise Authentication: Select this option to log in with your corporate credentials, such as Single Sign-On or Keycloak.
   • OAuth Provider: Select an external provider, such as GitHub or GitLab, if your organization manages developer identities through those services.

   • Guest Access: If available, select Enter as Guest for read-only exploration.

     Note

     Guest access typically has limited permissions and does not allow you to create or register new components.

3. Enter your credentials and complete the required authentication prompts.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Click the Kind filter and select Component.
4. Optional: Click the Type filter to narrow the list to a specific functional category, such as Library, Website, or Tool.
5. Enter the component name in the Search bar at the top of the Catalog page.
6. Select the component card from the results to view its Overview, Docs, and Relationships.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Click the Kind filter and select Component.
4. Click the Type filter and select Service.
5. Optional: Narrow the list by selecting a specific Owner or Lifecycle, such as production or experimental.
6. Select a service card to open the detailed entity view.
7. Review the Overview tab to identify the assigned owner and access links to the source code repository.
8. Select the Dependencies or Relations tab to see upstream and downstream connections for that service.

Procedure

1. Navigate to the RHDH interface.

2. In the left navigation sidebar, click APIs.

   Note

   You can also find these resources by clicking Catalog and selecting API from the Kind filter.

3. Select an API from the list to open the detail view.
4. Select the Overview tab to examine the metadata, assigned owner, and lifecycle status.
5. Select the Definition tab to view the rendered specification, such as an interactive Swagger or AsyncAPI interface.

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog > Self-service. Alternatively, to go to Self-service page, in your header menu, click the (+) icon.

2. Click the More options icon and select Manage Templates.

   
   Note

   • The following options on the Managed Templates page do not create a software component in your Red Hat Developer Hub instance:

     • Template Form Playground: Use to create and test the templates.yaml file
     • Custom Field Explorer: Use to test custom fields

3. On the Managed Templates page, select any of the following options:

   • Load Template Directory: Use to load an existing templates.yaml file

     • In your local file manager, navigate to the folder where your templates.yaml file is stored and click Select.

   • Create New Template: Use to create a templates.yaml file

     1. In your local file manager, navigate to the folder where you want the Template Editor to create a templates.yaml file and click Select.
     2. On the Template Editor page, select the templates.yaml file.

     3. (Optional) You can preview and test your template specifications.

        1. On the Fill in some steps tab, enter text into the required fields and click Next.
        2. On the Repository Location tab, enter text into the required fields and click Review.
        3. Modify the YAML definition for the parameters of your template. For more information about these parameters, see Section 4.2, “Creating a Software Template as a YAML file”.
        4. Review the information for accuracy, then click Create.
     4. After the Software Template is created, import your Software Template in your RHDH instance.

Verification

1. Click the Catalog tab in the navigation panel.
2. In the Kind drop-down menu, select Template.
3. Confirm that your template is shown in the list of existing templates.

Procedure

1. In your Red Hat Developer Hub navigation menu, click Catalog > Self-service.
2. On the Self-service page, click Choose on the Templates tile to initiate the scaffolding process for a template.
3. Follow the wizard instructions, entering the required details, and selecting from pre-defined options.

4. Optional: In the Deployment Information step, you have an option to Create Workbench for OpenShift AI.

   Note

   This option is only available for certain templates.

5. In the Review step, verify the parameters you have entered and click Create.

   The scaffolding process begins. You can view the logs during the process or click Cancel to abort the operation.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Catalog > Self-service.
2. In the Search box, enter the name of the Software Template.
3. Optional: To filter results, select a category from the Categories dropdown list.

Procedure

1. Open your RHDH app-config.yaml configuration file.

2. In the catalog.rules section, add a rule to allow Templates kinds, as shown in the following example:

   # ...
   catalog:
     rules:
       - allow: [Template]
     locations:
       - type: url
         target: https://<repository_url/template-name>.yaml
   # ...

   where:

   catalog.rules.allow

   Specify the Template rule to allow new Software Templates in the catalog.

   catalog.locations.type

   Specify the url type when importing templates from a repository (for example, GitHub or GitLab).

   catalog.locations.target

   Specify the full URL to the template file.

Verification

1. In the Red Hat Developer Hub navigation menu, click Catalog.
2. From the Kind list, select Template.
3. Verify that your template appears in the Template list.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Docs.
2. On the Documentation page, use the search bar, filters, or both to locate the document that you want to view.

Procedure

1. In the Red Hat Developer Hub navigation menu, click Docs.
2. In the Documentation table, click the name of the document that you want to view.

3. On the book page, navigate the document using the following tools:

   • Search bar: Find keywords within the document.
   • Table of contents: Skip to specific sections of the current document.
   • Navigation menu: Open other documents in the book.
   • Next: Go to the next sequential document in the book.
   • Add-ons: Use installed add-ons to perform additional actions.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Click the Kind filter and select Component.
4. Optional: Click the Type filter to narrow the list to a specific functional category, such as Library, Website, or Tool.
5. Enter the component name in the Search bar at the top of the Catalog page.
6. Select the component card from the results to examine its Overview, Docs, and Relationships.

Procedure

1. Navigate to the specific API you must validate and select the Definition tab.
2. Locate the operation you want to verify and select the header to expand the details.
3. Click Try it out to enable the interactive input fields.
4. Enter the required parameters or the request body JSON in the provided fields.
5. Click Execute.
6. Examine the Server response section to verify the status code, response body, and headers.

Procedure

1. Click the Search input field in the Global Header.
2. Enter your query, such as a service name, API endpoint, or technical concept.
3. Review the instant results in the dropdown menu, which categorize matches by entity types such as Components, APIs, TechDocs, and Users.
4. Select a suggestion from the list to navigate directly to that resource.

Procedure

1. Enter your query in the Search bar in the Global Header.
2. Click the All results…​ link at the bottom of the results dropdown menu.

3. In the Filters panel, select the following options to refine the list:

   • Kind: Filter by entity category, such as Component, API, Template, or Group.
   • Type: Narrow the results by functional subtype, such as service, library, or website.
   • Lifecycle: Isolate resources by their operational status, such as production, experimental, or deprecated.
4. Review the filtered results to identify the description and owner of the resource.
5. Optional: Use the pagination controls at the bottom of the page to navigate through large result sets.

Procedure

1. In the RHDH navigation menu, click Lightspeed.

2. Start a chat using one of the following methods:

   • Manual entry: Type your query in the Send a message field and press Enter.
   • Sample prompts: Click a prompt tile, such as Deploy with Tekton, to start a predefined task.
   • File attachment: Click the Attach icon to upload a file (.yaml, .json, or .txt) for analysis.

Procedure

1. In your RHDH navigation menu, click Lightspeed.
2. In the Developer Lightspeed for RHDH virtual assistant interface, click New chat.

Procedure

1. In the RHDH navigation menu, click Lightspeed. Developer Lightspeed for RHDH opens with your previous chat.
2. Select a chat title from the history list to view the full conversation.
3. Optional: Use the Search previous chats…​ field to filter the history list by keyword.

Procedure

1. In your RHDH navigation menu, click Lightspeed. Developer Lightspeed for RHDH opens with your previous chat.
2. In Developer Lightspeed for RHDH, click the vertical ellipsis (⋮) next to the chat title you want to remove.
3. Select Delete.

Procedure

1. Log in to your RHDH instance.

2. In the left navigation sidebar, locate the standard or custom items that represent specific global extensions, such as:

   • Tech Radar: Use this to visualize your organization’s approved and deprecated technologies.
   • Cost Insights: Use this to track and analyze cloud infrastructure spending for your projects.
   • Developer Lightspeed: Access this conversational interface for AI-assisted development help and platform queries.
   • Learning Paths: Access training and educational resources to improve your technical skills.

Procedure

1. Navigate to the RHDH interface.
2. In the left navigation sidebar, click Catalog.
3. Select a Component or Service card.

4. Review the tabs at the top of the entity page to view configured plugins:

   • CI/CD: Displays build status and history from tools such as Jenkins or GitHub Actions.
   • Kubernetes: Shows deployment status and pod health.
   • Topology: Visualizes the relationships and status of running resources.

Procedure

1. In the left navigation sidebar, click Extensions.

2. Browse the marketplace to review the following categories:

   • Installed: Review the integrations currently active in your instance, such as Jira, ArgoCD, or GitHub.
   • Available: Examine additional integrations supported by the platform that are not yet enabled for your workspace.

Procedure

1. In the Global Header, click your avatar or name to open the user menu.
2. Select Settings.

3. In the Appearance section, configure the following options:

   • Theme: Select Light, Dark, or Auto to synchronize the portal with your operating system preferences.
   • Language: Select your preferred interface language from the list.
   • Pin Sidebar: Enable this toggle to keep the left navigation menu permanently expanded, or disable it to maximize your primary workspace area.

Procedure

1. In the Global Header, click your avatar or name to open the user menu.
2. Select My Profile.
3. Review the About card to verify that your account details, such as email and team tags, are accurate.
4. Examine the Ownership card to identify the software components, APIs, and systems currently linked to your identity.

5. Use the relations toggle to switch between the following views:

   • Direct Relations: View only the entities where you are explicitly listed as the owner.
   • Aggregated Relations: View all entities inherited through your team memberships or group hierarchies.

Procedure

1. In the Red Hat Developer Hub navigation menu, select Catalog.
2. Locate the components you want to add as a favorite.
3. In the Actions column for that component, click the Add to favorites (star) icon.