New content

Author: pabel-rh

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-adjusting-interface-settings.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,14 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="discover-and-test-available-apis"]
+= Discover and test available APIs
+
+To integrate with 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]

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

@@ -0,0 +1,12 @@
+:_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]

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

@@ -0,0 +1,17 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="find-software-components-using-software-catalog"]
+= Find software components using the Software Catalog
+
+When you need to integrate with existing software in {product} ({product-very-short}), verify ownership, or check if a solution already exists, you can browse the Software Catalog. The catalog acts as a centralized inventory of your organization's software ecosystem, allowing you to discover assets without hunting through scattered documentation or repositories.
+The catalog helps you achieve the following outcomes:
+
+* Reuse existing code: Discover shared libraries and components to avoid duplication.
+* Understand dependencies: Visualize how services and APIs connect to one another.
+* Identify ownership: Quickly find the team or individual responsible for a specific asset.
+
+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]

assemblies/assembly-get-ai-assisted-help.adoc

@@ -0,0 +1,11 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="get-ai-assisted-help"]
+= Get AI-assisted help in {product-very-short}
+
+To assist with development tasks and platform questions, use {ls-brand-name} a generative AI virtual assistant integrated directly into {product} ({product-very-short}). You can use the assistant to get context-aware answers from official documentation and receive general coding or debugging assistance.
+
+include::modules/quickly-gain-access-and-find-what-you-need-in-rhdh/ref-get-the-best-results-for-assistant-queries.adoc[leveloffset=+1]
+
+.Additional resources
+* link:{developer-lightspeed-link}[Interacting with {ls-brand-name}]

assemblies/assembly-log-in-rhdh.adoc

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="log-in-to-rhdh"]
+= Log in to {product}
+
+To begin using the {product} ({product-very-short}), you must first access the portal and authenticate using your organization's configured identity provider. This ensures secure access to your organization's software catalog, templates, and documentation.
+
+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-familiarize-yourself-within-the-rhdh-interface.adoc[leveloffset=+1]

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

@@ -0,0 +1,25 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="understand-the-purpose-and-structure-of-rhdh"]
+= Understand the purpose and structure of {product}
+
+{product} ({product-very-short}) is an internal developer portal (IDP) designed to streamline the software development lifecycle. Built on the open source CNCF Backstage project, RHDH provides a unified interface that centralizes infrastructure, tools, services, and documentation.
+
+.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]

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 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-view-available-extensions-and-plugins.adoc

@@ -0,0 +1,14 @@
+:_mod-docs-content-type: ASSEMBLY
+
+[id="view-available-extensions-and-plugins"]
+= Viewing available extensions and plugins in {product-very-short}
+
+To integrate your tools and customize your development experience, explore the extensions and plugins available in {product} ({product-very-short}). You can discover global features in the navigation sidebar, review entity-specific data in the catalog, or browse the comprehensive extensions marketplace.
+
+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]

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

@@ -0,0 +1,51 @@
+:_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
+
+As a developer accessing a production {product-very-short} instance for the first time, you need to verify your access, confirm your ownership of software components, and configure your personal workspace. This ensures you can immediately find your team's services and utilize self-service capabilities.
+
+.1. Log in and verify your profile
+
+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.
+
+.2. Organize your workspace
+
+{product-very-short} contains your organization's entire software ecosystem. To work efficiently, you should curate a list of resources you use daily.
+
+Star your services::
+Browse the Catalog, find the components you work on, and click the *Star icon* (⭐) to add them to your favorites.
+
+Access Starred Items::
+Verify that your starred components appear in the *Starred Items* list in the *Global Header* for quick access.
+
+Pin the Sidebar::
+If you navigate frequently between the Catalog, Templates, and Docs, go to *Settings* and toggle *Pin Sidebar* to keep the navigation menu visible.
+
+.3. Explore production resources
+
+Production instances often grant access to live infrastructure and specific documentation that may not be available in local or staging environments.
+
+Review Production Documentation::
+Use the *Docs* navigation item to check for "Runbooks" or "Production Deployment Guides" associated with your components.
+
+Check Production APIs::
+Navigate to the *APIs* page to verify that production API endpoints are discoverable and that their definitions (OpenAPI/Swagger) are up to date.
+
+Test Self-Service Templates::
+Click the *Create* (plus +) button in the *Global Header* to view available Software Templates. Ensure you have access to the "Golden Path" templates required for creating new production-ready services.
+
+.Next steps
+
+* *Start your day:* Navigate to the {product-very-short} *Home Page* to view your personalized dashboard, including "Your Items" and recently viewed resources.
+* *Learn the interface:* Review the Navigation Guide to understand the Global Header and Sidebar tools.
+* *Get AI assistance:* If enabled in production, open {ls-short} to ask questions about your new environment.