RHIDP-8377: End user documentation

artifacts/attributes.adoc

@@ -155,6 +155,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
@@ -174,6 +176,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/quickly-gain-access-and-find-what-you-need-in-rhdh/index
+:getting-started-developers-title: Quickly gain access and find what you need in {product}
 :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

assemblies/assembly-customize-interface-settings.adoc

@@ -0,0 +1,15 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="customize-interface-settings"]
+= Customize your {product-very-short} interface settings
+
+To suit your working environment and verify your account details, adjust the interface settings and review your user profile in {product} ({product-very-short}).
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-customizing-your-workspace-interface.adoc[leveloffset=+1]
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-verifying-identity-and-ownership.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}]

assemblies/assembly-discover-and-test-available-apis.adoc

@@ -0,0 +1,18 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="discover-and-test-available-apis"]
+= Discover and test available APIs
+
+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 ensures your application correctly interfaces with backend services before you begin integration.
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-finding-and-viewing-api-definition.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-validating-api-endpoints.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-supported-api-specifications.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* {customizing-book-link}[{customizing-book-title}]

assemblies/assembly-find-resources-and-documentation-using-search.adoc

@@ -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/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-locating-resources-instantly.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-filtering-and-refining-search-results.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* {customizing-book-link}[{customizing-book-title}]

assemblies/assembly-find-software-components-using-software-catalog.adoc

@@ -0,0 +1,24 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="find-software-components-using-software-catalog"]
+= Find software components using the Software Catalog
+
+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/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-finding-components-in-rhdh.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-finding-services-in-rhdh.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-finding-api-definitions-in-rhdh.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+
+* {about-book-link}[{about-book-title}]
+* {customizing-book-link}[{customizing-book-title}]

assemblies/assembly-finding-and-viewing-techdocs.adoc

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="finding-and-viewing-techdocs"]
+= Finding and viewing Technical Documentation (TechDocs)
+
+To manage and consume software documentation efficiently, locate and view TechDocs directly in the {product} ({product-very-short}) portal. You can review architecture diagrams, installation guides, and component details alongside corresponding software entities in a single interface
+
+By centralizing documentation, you ensure that technical resources are always accessible within the context of the services you develop. This direct access eliminates the need to navigate disparate repositories when verifying software requirements or implementation details.
+
+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}]

assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc

@@ -4,11 +4,9 @@
 [id="{context}"]
 = Importing and using an existing Software Template for faster development
 
-You can configure Software Templates to create software components and publish these components to Git repositories.
-Once the components are published to Git repositories, register these components in the Software Catalog.
+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.
 
-A template is a form composed of different UI fields that is defined in a YAML file.
-Software Templates include _actions_, which are steps that are executed in sequential order and can be executed conditionally.
+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]
 
@@ -18,4 +16,9 @@ include::modules/importing-and-using-an-existing-template-for-faster-development
 
 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]
+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}]

assemblies/assembly-log-in-rhdh.adoc

@@ -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/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-logging-in-to-rhdh.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-supported-authentication-providers.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/con-navigate-the-rhdh-interface.adoc[leveloffset=+1]
+
+.Additional resources
+* {authentication-book-link}[{authentication-book-title}]
+* {customizing-book-link}[{customizing-book-title}]

assemblies/assembly-managing-starred-items-for-quick-access.adoc

@@ -0,0 +1,15 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="managing-starred-items-for-quick-access"]
+= Managing starred items in {product-very-short} 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}]

assemblies/assembly-understand-the-purpose-and-structure-of-rhdh.adoc

@@ -0,0 +1,29 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="understand-the-purpose-and-structure-of-rhdh"]
+= Understand the 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/quickly-gain-access-and-find-what-you-need-in-rhdh/con-checklist-for-your-first-rhdh-instance-in-prod.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/con-explore-core-features-for-developer-productivity.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/con-distinguish-rhdh-from-backstage.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* {about-book-link}[{about-book-title}]

assemblies/assembly-understand-the-user-interface-and-navigation.adoc

@@ -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/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-access-tools-and-search-using-global-header.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-browse-core-resources-using-the-left-sidebar.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-personalizing-navigation-experience.adoc[leveloffset=+1]

assemblies/assembly-using-developer-lightspeed.adoc

@@ -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 in {product-very-short}
 
-: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:
@@ -53,3 +45,5 @@ include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspe
 include::modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc[leveloffset=+1]
 
 include::modules/developer-lightspeed/proc-deleting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-get-the-best-results-for-assistant-queries.adoc[leveloffset=+1]

assemblies/assembly-view-available-extensions-and-plugins.adoc

@@ -0,0 +1,18 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="view-available-extensions-and-plugins"]
+= Viewing available extensions and plugins in {product-very-short}
+
+To integrate your daily tools and customize your development experience, explore the extensions and plugins available in {product} ({product-very-short}). By discovering global features in the navigation sidebar or reviewing entity-specific data in the catalog, you can extend portal capabilities to include information from external services such as Jira, Jenkins, or ArgoCD.
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/con-understand-extensions-and-plugins.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-discovering-global-plugins.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-viewing-context-aware-entity-plugins.adoc[leveloffset=+1]
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/proc-browsing-the-extensions-marketplace.adoc[leveloffset=+1]
+
+[role="_additional-resources"]
+.Additional resources
+* {introduction-to-plugins-book-title}[{introduction-to-plugins-book-title}]

modules/quickly-gain-access-and-find-what-you-need-in-rhdh/con-checklist-for-your-first-rhdh-instance-in-prod.adoc

@@ -0,0 +1,38 @@
+:_mod-docs-content-type: CONCEPT
+
+[id="con-checklist-for-your-first-rhdh-instance-in-prod_{context}"]
+= Checklist for your first {product-very-short} instance in production
+
+To establish a productive workflow in a production {product-very-short} instance as a developer, you must verify your access permissions, confirm ownership of software entities, and personalize your interface. With this process, you can locate team services and utilize self-service capabilities immediately.
+
+.Log in and verify your profile
+
+Because production environments often use different authentication providers (such as corporate SSO) than test environments, your first step is to confirm you are logged in as the correct user and that the platform recognizes your identity.
+
+* *Authenticate*: Access your organization's {product-very-short} URL and log in using your corporate credentials.
+
+* *Check your identity*: Click your avatar or name in the Global Header and select *Settings*. Verify that the *User Entity* matches your corporate identity.
+
+* *Verify Ownership*: Navigate to *My Profile* from the user menu. Check the *Ownership* card to ensure it lists the components, APIs, and systems you or your team are responsible for. If this list is empty, you may need to register your ownership in the Software Catalog.
+
+.Organize your workspace
+
+To reduce navigation time across the software ecosystem, curate a list of high-priority resources.
+
+* *Star your services*: Locate your frequently used components in the *Catalog* and select the *Star* icon to add them to your favorites.
+* *Access starred items*: Use the *Starred Items* menu in the Global Header to open your favorite resources quickly.
+* *Pin the Sidebar*: If you switch frequently between tools, go to *Settings* and enable *Pin Sidebar* to keep the navigation menu permanently visible. See Personalizing the navigation experience in {product-very-short}.
+
+.Explore production resources
+
+Production instances provide access to live infrastructure data and technical guides required for operational tasks.
+
+* *See production documentation*: Use the *Docs* menu to find production-specific documentation, such as runbooks or deployment guides linked to your components.
+* *Check production APIs*: Navigate to the *APIs* page to confirm that production endpoint definitions are accurate and discoverable.
+* *Test Self-Service templates*: Click *Create* (+) in the Global Header to examine available Software Templates. Confirm that you have access to the templates required to generate new production services.
+
+.Next steps
+
+* *Start your day*: Navigate to the {product-very-short} *Home Page* to view your personalized dashboard.
+* *Learn the interface*: Understand the Global Header and Sidebar tools.
+* *Get AI assistance*: If enabled in production, open {ls-short} to ask questions about your new environment.