Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
41 commits
Select commit Hold shift + click to select a range
ac41748
New content
pabel-rh Dec 18, 2025
282c0a8
Added existing content into new TOC
pabel-rh Dec 18, 2025
fc263c3
Added additional resources for assemblies
pabel-rh Dec 18, 2025
9fc87db
Job-oriented changes in content
pabel-rh Dec 18, 2025
6001c89
Added links to checklist
pabel-rh Dec 18, 2025
607fd71
Fixing vale errors
pabel-rh Dec 18, 2025
beb518a
Fixed xref errors
pabel-rh Dec 18, 2025
578c8f2
Fixing build error
pabel-rh Dec 19, 2025
84dc75d
Removed links, will add later
pabel-rh Dec 19, 2025
8559f55
Minor change
pabel-rh Dec 19, 2025
36970f5
Incorporated Heena's suggestions
pabel-rh Jan 13, 2026
3d0e0e3
Minor change
pabel-rh Jan 13, 2026
a7d7c6d
Ported delta changes from ch 1 to ch 3
pabel-rh Feb 10, 2026
6fe2c2b
final changes
pabel-rh Feb 10, 2026
25686b3
Fix build error
pabel-rh Feb 10, 2026
968880b
RHIDP-9780 doc updates
pabel-rh Feb 11, 2026
2d27b66
RHIDP-9782 - FAB updates
pabel-rh Feb 11, 2026
5f99610
RHIDP-12124, except change 5
pabel-rh Feb 11, 2026
2768734
Incorporated Jordan's and Maysun's comments
pabel-rh Feb 12, 2026
2a61b82
Minor changeS
pabel-rh Feb 12, 2026
257b498
Jordan's updates
pabel-rh Feb 13, 2026
c5d9649
Added safety guard content and updated llama stack image
pabel-rh Feb 16, 2026
fdcd0c3
test day updateS
pabel-rh Feb 16, 2026
3ab916f
Minor change
pabel-rh Feb 16, 2026
d183d87
test day comments
pabel-rh Feb 17, 2026
4be971c
Minor change
pabel-rh Feb 17, 2026
94ca93d
Onboarding page updates
pabel-rh Feb 17, 2026
6ca6f8c
Fixing build error
pabel-rh Feb 17, 2026
c885825
Minor changes
pabel-rh Feb 17, 2026
b2adc9d
Fix build error
pabel-rh Feb 17, 2026
ef71435
Fix build error
pabel-rh Feb 17, 2026
6aedbd1
Fixing build error
pabel-rh Feb 17, 2026
f42db06
Incorporated Jordan's and Yi Cai's comments
pabel-rh Feb 18, 2026
8b33274
Incorporated Debsmita's comments
pabel-rh Feb 18, 2026
b670566
Minor changeS
pabel-rh Feb 18, 2026
faff17a
Adding helm chart config
pabel-rh Feb 18, 2026
1ade3c4
Indentation changes
pabel-rh Feb 18, 2026
e78bc9f
Minor change to render right build
pabel-rh Feb 19, 2026
ea78ef2
Minor change
pabel-rh Feb 19, 2026
6fe6461
Incorporated Heena's comments
pabel-rh Feb 19, 2026
185204d
Incorporated Heena's final comments
pabel-rh Feb 19, 2026
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
4 changes: 4 additions & 0 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -155,10 +155,14 @@
:introduction-to-plugins-book-link: {product-docs-link}/html-single/introduction_to_plugins/index
:introduction-to-plugins-book-title: Introduction to plugins
:learning-path-data-json-link: link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json
:manage-and-consume-techdocs-link: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.8/html-single/manage_and_consume_technical_documentation_within_red_hat_developer_hub/index
:manage-and-consume-techdocs-title: Manage and consume technical documentation within {product}
:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
:monitoring-and-logging-book-link: {product-docs-link}/html-single/monitoring_and_logging/index
:monitoring-and-logging-book-title: Monitoring and logging
:navigate-rhdh-on-your-first-day-link: {product-docs-link}/html-single/navigate_red_hat_developer_hub_on_your_first_day/index
:navigate-rhdh-on-your-first-day-title: Navigate {product} on your first day
:observability-category-link: {product-docs-link}/#Observability
:ocp-docs-link: link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-version}
:odf-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_data_foundation/{ocp-version}
Expand Down
14 changes: 14 additions & 0 deletions assemblies/assembly-customize-interface-settings.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
:_mod-docs-content-type: ASSEMBLY

[id="customize-interface-settings"]
= Customize your {product-very-short} interface settings

Personalize your {product} ({product-very-short}) environment to align the portal with your system preferences and optimize your workspace. Reviewing your user profile also confirms your account details and software ownership in the Software Catalog.

include::modules/navigate-rhdh-on-your-first-day/proc-customize-interface-settings-and-profile-details.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {customizing-book-link}[{customizing-book-title}]
* {authentication-book-link}[{authentication-book-title}]
* {about-book-link}[{about-book-title}]
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:_mod-docs-content-type: ASSEMBLY

[id="find-resources-and-documentation-using-search"]
= Find resources and documentation using search

To find software components, APIs, and technical documentation across the enterprise, use the centralized search feature in {product} ({product-very-short}). By indexing the entire software ecosystem, this tool helps you locate services, templates, and team members directly, without navigating through nested menus.

By using the Search bar, you can access matching resources from the Software Catalog and TechDocs instantly. This unified access reduces the time spent switching between disparate documentation sites or service registries during the development lifecycle.

include::modules/navigate-rhdh-on-your-first-day/proc-locate-resources-instantly.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-filter-and-refine-search-results.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {customizing-book-link}[{customizing-book-title}]
21 changes: 21 additions & 0 deletions assemblies/assembly-finding-and-viewing-techdocs.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_mod-docs-content-type: ASSEMBLY

[id="finding-and-viewing-techdocs"]
= Searching for relevant content in Technical Documentation (TechDocs)

To reduce context switching and to make sure technical resources are accessible, use TechDocs in {product}. Centralizing documentation allows you to review architecture diagrams, installation guides, and component details alongside software entities in a single interface.

.Prerequisites

Check warning on line 8 in assemblies/assembly-finding-and-viewing-techdocs.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [AsciiDocDITA.BlockTitle] Block titles can only be assigned to examples, figures, and tables in DITA. Raw Output: {"message": "[AsciiDocDITA.BlockTitle] Block titles can only be assigned to examples, figures, and tables in DITA.", "location": {"path": "assemblies/assembly-finding-and-viewing-techdocs.adoc", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}

* The TechDocs plugin is enabled and configured.
* Documentation is imported into TechDocs.
* You have the required roles and permissions to access TechDocs content.

include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc[leveloffset=+1]

include::modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc[leveloffset=+1]

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

* {manage-and-consume-techdocs-link}[{manage-and-consume-techdocs-title}]
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
:_mod-docs-content-type: ASSEMBLY
:context: import-and-use-an-existing-template-for-faster-development

[id="{context}"]
= Import and use an existing Software Template for faster development

To standardize and accelerate the creation of new software, use Software Templates in {product} ({product-very-short}). You can generate consistent software components, publish them to Git repositories, and register them in the Software Catalog to make sure they are discoverable across your organization.

Each template uses a YAML definition to present a functional interface for inputting project metadata. Software Templates run a sequential series of _actions_, such as scaffolding code or creating repositories, which you can configure to run conditionally based on user input.

include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc[leveloffset=+1]

include::modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]

include::modules/importing-and-using-an-existing-template-for-faster-development/proc-adding-templates.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {about-book-link}[{about-book-title}]
* {customizing-book-link}[{customizing-book-title}]

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:_mod-docs-content-type: ASSEMBLY

[id="integrate-and-customize-your-daily-tools-using-extensions"]
= Integrate and customize your daily tools using extensions

To integrate your development tools into a single interface and customize your experience, use the extensions and plugins in {product} {product-very-short}. While core features such as the Software Catalog and TechDocs are pre-installed, you can add plugins to interact with external services such as Jira, Jenkins, or ArgoCD. By discovering global features in the navigation sidebar or reviewing entity-specific data in the catalog, you extend portal capabilities and access information from your daily tools directly within the portal.

include::modules/navigate-rhdh-on-your-first-day/proc-access-tools-using-global-plugins.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-review-rhdh-resource-data.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-identify-integrations-in-extensions-marketplace.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {introduction-to-plugins-book-link}[{introduction-to-plugins-book-title}]
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
:_mod-docs-content-type: ASSEMBLY

[id="locate-software-components-to-discover-assets"]
= Find software components to discover assets

To integrate with existing software, verify ownership, or prevent redundant development, use the Software Catalog in {product} ({product-very-short}). You can use this centralized inventory to discover assets without searching through multiple documentation sources or repositories.

By using the Software Catalog, you can achieve the following outcomes:

Reuse existing code::
Locate shared libraries and components to prevent duplication of effort.

Understand dependencies::
Visualize connections between services and API contracts.

Identify ownership::
Find the team or individual responsible for an asset to facilitate collaboration.

[NOTE]
====
Your administrator must grant specific permissions if you want to add the products you are working on to this catalog. Contact your administrator for more information.
====

include::modules/navigate-rhdh-on-your-first-day/proc-filter-components-in-software-catalog.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-analyze-microservice-dependencies.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-review-api-contracts.adoc[leveloffset=+1]

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

* {about-book-link}[{about-book-title}]
* {customizing-book-link}[{customizing-book-title}]
18 changes: 18 additions & 0 deletions assemblies/assembly-log-in-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
:_mod-docs-content-type: ASSEMBLY

[id="log-in-to-rhdh"]
= Log in to {product}

To access your organization's software catalog, templates, and documentation, you must authenticate with {product} ({product-very-short}) using your configured identity provider. With secure authentication, you have the appropriate permissions to view and manage software entities linked to your role.

By logging in, you gain entry to a centralized portal that streamlines your development workflow. This secure access allows you to locate required software building blocks and documentation without navigating multiple disparate systems.

include::modules/navigate-rhdh-on-your-first-day/proc-log-in-to-rhdh.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/ref-authentication-methods.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/con-navigate-the-rhdh-interface.adoc[leveloffset=+1]

.Additional resources
* {authentication-book-link}[{authentication-book-title}]
* {customizing-book-link}[{customizing-book-title}]
15 changes: 15 additions & 0 deletions assemblies/assembly-managing-starred-items-for-quick-access.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
:_mod-docs-content-type: ASSEMBLY

[id="managing-starred-items-for-quick-access"]
= Managing starred items for quick access

To streamline your daily workflow and reduce navigation time, use the starring feature in {product} ({product-very-short}). By starring key components, APIs, and services in the Software Catalog, you create a personalized list of high-priority resources accessible directly from your sidebar or homepage.

This personalization makes sure that you can locate the specific tools and documentation you use most frequently without performing repetitive searches across the software ecosystem.

include::modules/centralizing-your-software-components-in-rhdh/proc-starring-key-components-in-the-software-catalog.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {about-book-link}[{about-book-title}]
* {customizing-book-link}[{customizing-book-title}]
28 changes: 28 additions & 0 deletions assemblies/assembly-purpose-and-structure-of-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
:_mod-docs-content-type: ASSEMBLY

[id="purpose-and-structure-of-rhdh"]
= Purpose and structure of {product}

To streamline your software development lifecycle, your organization has chosen to use {product} ({product-very-short}) as your primary internal developer portal (IDP).

{product-very-short} offers a unified interface to manage infrastructure, generate software projects, use tools and services, and access technical documentation in a centralized location.

The developer experience challenge::
Modern software development often involves fragmented workflows. Developers frequently switch contexts between code repositories, ticketing systems, CI/CD pipelines, monitoring dashboards, and so on. This fragmentation creates information silos and increases the time required to find API documentation, service ownership details, or deployment status.

Improving developer productivity with {product-very-short}::
{product-very-short} centralizes fragmented technical resources to streamline the developer experience. The platform provides the following advantages:

* *Unified discovery:* Locate applications, APIs, and documentation in a single, accessible location.
* *Search capabilities*: Find users, groups, and catalog using an integrated search feature. Once indexed, all entities become discoverable across the entire ecosystem within seconds.
* *Self-service capabilities:* Create projects and deploy services using automated Software Templates. This ensures consistency and reduces reliance on manual ticketing.
* *Service visibility:* Map relationships between services, dependencies, and API contracts to clarify ownership and component linkages.
* *Extensibility:* Integrate external tools, such as monitoring dashboards and pipelines, directly into the portal to create a unified interface.

include::modules/navigate-rhdh-on-your-first-day/con-overview-of-the-onboarding-workflow.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/con-leverage-rhdh-capabilities-for-daily-productivity.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {about-book-link}[{about-book-title}]
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
:_mod-docs-content-type: ASSEMBLY

[id="understand-the-user-interface-and-navigation"]
= Understand the user interface and navigation

Navigate the {product} ({product-very-short}) interface by using the two core components: the Global Header and the left navigation sidebar.

include::modules/navigate-rhdh-on-your-first-day/ref-access-tools-and-search-using-global-header.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/ref-browse-core-resources-using-the-left-sidebar.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/proc-personalize-navigation-experience.adoc[leveloffset=+1]
53 changes: 8 additions & 45 deletions assemblies/assembly-using-developer-lightspeed.adoc
Original file line number Diff line number Diff line change
@@ -1,55 +1,18 @@
:_mod-docs-content-type: ASSEMBLY

ifdef::context[:parent-context-of-about-rhdh: {context}]
ifndef::context[]
[id="using-developer-lightspeed"]
endif::[]
ifdef::context[]
[id="using-developer-lightspeed_{context}"]
endif::[]
= Using {ls-short}
[id="get-ai-assisted-help"]
= Get AI-assisted help for your development tasks

:context: Using-developer-lightspeed
To assist with development tasks, platform questions, and debugging, use {ls-brand-name}, a generative AI virtual assistant integrated directly into {product} ({product-very-short}). You can use the conversational interface to ask platform-specific questions, analyze logs, generate code, and create test plans, which reduces the time spent searching through official documentation or disparate tools.

{ls-brand-name} is designed to help you perform development tasks through a conversational interface. You can ask questions, analyze logs, generate code, and create test plans.

.Capabilities
The scope of questions you can ask depends on your configuration:

* *Question Validation* enabled (default): Supports general questions about {product}. For example:

** “Tell me about {product}.”
** “What are the benefits of {product-very-short}?”
** “Can I use {product-very-short} on an {ocp-short}?”
** “How do I install plugins on {product}?”

* *Question Validation* disabled: Supports broader tasks such as log analysis, code generation, and creating Kubernetes deployments. For example:

** “Analyze this log for me…”
** “Suggest libraries and frameworks I can use to build Event Driven Architecture microservices.”
** “I'm not familiar with this language, so explain to me what this code snippet is doing…”
** “Create a Kubernetes deployment for this service…”
** “Create a test plan for the following scenarios and conditions…”
** “Create a Jira record that describes the following feature…”
** “Draft the end-user documentation describing how to use the following cli command…”

[NOTE]
====
The `Question Validation` feature is enabled by default if you are using the `quay.io/redhat-ai-dev/llama-stack` image without overriding the `run.yaml` configuration file in the image. To disable `Question Validation`, you must mount a `run.yaml` file to the container with the following sections removed:

* `Safety`
* `Shields`
* `External_providers_dir` set to `null`
====
include::modules/developer-lightspeed/proc-configure-safety-guards-in-rhdh.adoc[leveloffset=+1]

.Prerequisites

* You have the {ls-short} plugin configured in your {product-very-short} instance.

include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
* Your platform engineer has installed and configured the {ls-short} plugin in your {product-very-short} instance.

include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc[leveloffset=+1]
include::modules/navigate-rhdh-on-your-first-day/ref-get-the-best-results-for-assistant-queries.adoc[leveloffset=+1]

include::modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc[leveloffset=+1]
include::modules/navigate-rhdh-on-your-first-day/con-monitor-ai-responses-and-context-management.adoc[leveloffset=+1]

include::modules/developer-lightspeed/proc-deleting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
include::modules/developer-lightspeed/proc-managing-chats.adoc[leveloffset=+1]
16 changes: 16 additions & 0 deletions assemblies/assembly-verify-api-contracts-before-integration.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
:_mod-docs-content-type: ASSEMBLY

[id="verify-api-contracts-before-integration"]
= Verify API contracts before integrating with backend services

To integrate with existing services and understand component communication, use the {product} ({product-very-short}) API browser to locate, inspect, and validate API definitions in a centralized interface. You can review API contracts and test endpoints to verify responses directly from the portal.

Apart from viewing specifications, you can use the interactive interface to test available endpoints and review data models. This verification confirms that your application correctly interfaces with backend services before you begin integration.

include::modules/navigate-rhdh-on-your-first-day/proc-test-api-endpoints.adoc[leveloffset=+1]

include::modules/navigate-rhdh-on-your-first-day/ref-supported-api-specifications.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources
* {customizing-book-link}[{customizing-book-title}]
Loading