Skip to content
Draft
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
4 changes: 4 additions & 0 deletions artifacts/attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,8 @@
: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
Expand All @@ -176,6 +178,8 @@
:rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version}
:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
:getting-started-developers-link: {product-docs-link}/html-single/navigate-rhdh-on-your-first-day/index
:getting-started-developers-title: Navigate {product} on your first day
:techdocs-book-link: {product-docs-link}/html-single/techdocs_for_red_hat_developer_hub/index
:techdocs-book-title: TechDocs for {product}
:telemetry-data-collection-book-link: {product-docs-link}/html-single/telemetry_data_collection_and_analysis/index
Expand Down
30 changes: 30 additions & 0 deletions assemblies/assembly-customize-interface-settings.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
:_mod-docs-content-type: ASSEMBLY

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

To optimize your workspace for productivity and maintain accurate asset tracking, customize the interface settings and review your user profile in Red Hat Developer Hub (RHDH). Personalizing your environment aligns the portal with your system preferences, while reviewing your profile confirms that you are correctly associated with your team's services in the Software Catalog.

Check failure on line 6 in assemblies/assembly-customize-interface-settings.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Red Hat Developer Hub'. Raw Output: {"message": "[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Red Hat Developer Hub'.", "location": {"path": "assemblies/assembly-customize-interface-settings.adoc", "range": {"start": {"line": 6, "column": 148}}}, "severity": "ERROR"}

.Procedure

Check warning on line 8 in assemblies/assembly-customize-interface-settings.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-customize-interface-settings.adoc", "range": {"start": {"line": 8, "column": 1}}}, "severity": "WARNING"}

. In the {product-very-short} global header, click your avatar or name to open the user menu.
. To customize the interface:
.. Select *Settings*.
.. 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.

. To verify your identity and software ownership:
.. Open the user menu again and select *My Profile*.
.. Review the *About* card to confirm that your account details, such as email and team tags, are accurate.
.. Examine the *Ownership* card to identify the software components, APIs, and systems linked to your identity.
.. Use the relations toggle to switch between the following views:
*** *Direct Relations*: View entities where you are explicitly listed as the owner.
*** *Aggregated Relations*: View entities inherited through team memberships or group hierarchies.

[role="_additional-resources"]
.Additional resources
* {customizing-book-link}[{customizing-book-title}]
* {authentication-book-link}[{authentication-book-title}]
* {about-book-link}[{about-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 ensure 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,24 @@
:_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-templates.adoc[leveloffset=+1]

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

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 toolchain 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 like 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.

Check warning on line 6 in assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term. Raw Output: {"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc", "range": {"start": {"line": 6, "column": 298}}}, "severity": "WARNING"}

Check warning on line 6 in assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'toolchain'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'toolchain'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc", "range": {"start": {"line": 6, "column": 31}}}, "severity": "WARNING"}

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

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

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

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

[id="Locate-resources-and-documentation-using-search"]
= Locate resources and documentation using search

To locate 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-locating-resources-instantly.adoc[leveloffset=+1]

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

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

[id="locate-software-components-to-discover-assets"]
= Locate 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}). This centralized inventory of your organization's software ecosystem helps you discover assets without searching through disparate documentation 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 specific team or individual responsible for an asset to facilitate collaboration.

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

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

include::modules/navigate-rhdh-on-your-first-day/proc-reviewing-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-logging-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 ensures 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}]
29 changes: 29 additions & 0 deletions assemblies/assembly-purpose-and-structure-of-rhdh.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
:_mod-docs-content-type: ASSEMBLY

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

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

You can access a unified interface to manage infrastructure, tools, services, and 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, and monitoring dashboards. This fragmentation creates information silos and increases the time required to find API documentation, service ownership details, or deployment status.

The {product-very-short} solution::
{product-very-short} addresses these challenges by consolidating resources into a single, searchable portal. This centralization offers the following advantages:

* *Unified discovery:* Users can locate applications, APIs, and documentation in one location.
* *Self-service capabilities:* Developers can create projects and deploy services using automated templates, reducing reliance on manual ticketing.
* *Service visibility:* The platform maps relationships between services, dependencies, and API contracts.
* *Extensibility:* Users can integrate external tools, such as monitoring dashboards and pipelines, directly into the interface.

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

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

include::modules/navigate-rhdh-on-your-first-day/con-distinguish-rhdh-from-backstage.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-personalizing-navigation-experience.adoc[leveloffset=+1]
22 changes: 5 additions & 17 deletions assemblies/assembly-using-developer-lightspeed.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,9 @@
:_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

{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.
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.

.Capabilities
The scope of questions you can ask depends on your configuration:
Expand Down Expand Up @@ -46,10 +38,6 @@ The `Question Validation` feature is enabled by default if you are using the `qu

* 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]

include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc[leveloffset=+1]

include::modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc[leveloffset=+1]
include::modules/developer-lightspeed/proc-managing-chats.adoc[leveloffset=+1]

include::modules/developer-lightspeed/proc-deleting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
include::modules/navigate-rhdh-on-your-first-day/ref-get-the-best-results-for-assistant-queries.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-validating-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
Loading