diff --git a/artifacts/attributes.adoc b/artifacts/attributes.adoc index f47e6a1765..a810ea8793 100644 --- a/artifacts/attributes.adoc +++ b/artifacts/attributes.adoc @@ -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 @@ -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 diff --git a/assemblies/assembly-customize-interface-settings.adoc b/assemblies/assembly-customize-interface-settings.adoc new file mode 100644 index 0000000000..5d2f5677fd --- /dev/null +++ b/assemblies/assembly-customize-interface-settings.adoc @@ -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. + +.Procedure + +. 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}] \ No newline at end of file diff --git a/assemblies/assembly-finding-and-viewing-techdocs.adoc b/assemblies/assembly-finding-and-viewing-techdocs.adoc new file mode 100644 index 0000000000..fce59998cf --- /dev/null +++ b/assemblies/assembly-finding-and-viewing-techdocs.adoc @@ -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 + +* 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}] \ No newline at end of file diff --git a/assemblies/assembly-import-and-use-an-existing-template-for-faster-development.adoc b/assemblies/assembly-import-and-use-an-existing-template-for-faster-development.adoc new file mode 100644 index 0000000000..84d3d78353 --- /dev/null +++ b/assemblies/assembly-import-and-use-an-existing-template-for-faster-development.adoc @@ -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}] \ No newline at end of file diff --git a/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc b/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc deleted file mode 100644 index 98e981ea6f..0000000000 --- a/assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc +++ /dev/null @@ -1,21 +0,0 @@ -:_mod-docs-content-type: ASSEMBLY -:context: importing-and-using-an-existing-template-for-faster-development - -[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. - -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. - -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] \ No newline at end of file diff --git a/assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc b/assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc new file mode 100644 index 0000000000..4063b7a369 --- /dev/null +++ b/assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc @@ -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. + +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}] diff --git a/assemblies/assembly-locate-resources-and-documentation-using-search.adoc b/assemblies/assembly-locate-resources-and-documentation-using-search.adoc new file mode 100644 index 0000000000..7b5e3fd655 --- /dev/null +++ b/assemblies/assembly-locate-resources-and-documentation-using-search.adoc @@ -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}] \ No newline at end of file diff --git a/assemblies/assembly-locate-software-components-to-discover-assets.adoc b/assemblies/assembly-locate-software-components-to-discover-assets.adoc new file mode 100644 index 0000000000..f4751fddee --- /dev/null +++ b/assemblies/assembly-locate-software-components-to-discover-assets.adoc @@ -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}] diff --git a/assemblies/assembly-log-in-rhdh.adoc b/assemblies/assembly-log-in-rhdh.adoc new file mode 100644 index 0000000000..66cf0956aa --- /dev/null +++ b/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/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}] diff --git a/assemblies/assembly-managing-starred-items-for-quick-access.adoc b/assemblies/assembly-managing-starred-items-for-quick-access.adoc new file mode 100644 index 0000000000..88a1f0f9d4 --- /dev/null +++ b/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 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}] \ No newline at end of file diff --git a/assemblies/assembly-purpose-and-structure-of-rhdh.adoc b/assemblies/assembly-purpose-and-structure-of-rhdh.adoc new file mode 100644 index 0000000000..41208be278 --- /dev/null +++ b/assemblies/assembly-purpose-and-structure-of-rhdh.adoc @@ -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}] \ No newline at end of file diff --git a/assemblies/assembly-understand-the-user-interface-and-navigation.adoc b/assemblies/assembly-understand-the-user-interface-and-navigation.adoc new file mode 100644 index 0000000000..61257e57aa --- /dev/null +++ b/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/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] \ No newline at end of file diff --git a/assemblies/assembly-using-developer-lightspeed.adoc b/assemblies/assembly-using-developer-lightspeed.adoc index 0e7b2f3b54..8ad21563f6 100644 --- a/assemblies/assembly-using-developer-lightspeed.adoc +++ b/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 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: @@ -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] \ No newline at end of file diff --git a/assemblies/assembly-verify-api-contracts-before-integration.adoc b/assemblies/assembly-verify-api-contracts-before-integration.adoc new file mode 100644 index 0000000000..dc069d48a9 --- /dev/null +++ b/assemblies/assembly-verify-api-contracts-before-integration.adoc @@ -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}] \ No newline at end of file diff --git a/modules/developer-lightspeed/proc-managing-chats.adoc b/modules/developer-lightspeed/proc-managing-chats.adoc new file mode 100644 index 0000000000..049310ab30 --- /dev/null +++ b/modules/developer-lightspeed/proc-managing-chats.adoc @@ -0,0 +1,28 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-managing-chats_{context}"] += Managing chats + +To get rapid answers to technical questions and maintain context for AI-assisted development, use the virtual assistant in {product}. Managing your chat history allows you to resume previous tasks, search for past solutions, and clear irrelevant data to keep your workspace organized. + +.Prerequisites +* The {ls-short} plugin is configured in your {product} instance. +* You are logged in to the portal. + +.Procedure + +. In the {product-very-short} navigation menu, click *Lightspeed*. +. Start or continue a chat using one of the following methods: + +** *Manual entry*: Type a query in the *Send a message* field and press **Enter**. +** *Sample prompts*: Click a prompt tile, such as *Deploy with Tekton*, to initiate a predefined task. +** *File attachment*: Click the *Attach* icon to upload a `.yaml`, `.json`, or `.txt` file for analysis. +** *Existing chat*: Select a title from the history list to load a previous chat. +. To manage your chat context or history, perform one of the following actions: + +** *Start a new topic*: Click *New chat* to reset the assistant's context. +** *Filter history*: Use the *Search previous chats* field to find specific conversations by keyword. +** *Remove a chat*: Click the vertical ellipsis (⋮) next to a chat title and select *Delete*. + +.Verification +* Confirm that the main window displays the active chat and the history list reflects any new, filtered, or deleted entries. \ No newline at end of file diff --git a/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc b/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc deleted file mode 100644 index 5b01b64993..0000000000 --- a/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc +++ /dev/null @@ -1,11 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="proc-starting-a-chat-in-developer-lightspeed-after-the-first-time_{context}"] -= Starting a chat in {ls-short} after the first chat - -After you have started a chat with the {ls-short} for the first time, you can reset the chat context for a new topic. Even if you log out and log back in, your previous chats are automatically saved in your history. - -.Procedure - -. In your {product-very-short} navigation menu, click *Lightspeed*. -. In the {ls-short} virtual assistant interface, click *New chat*. diff --git a/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed.adoc b/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed.adoc deleted file mode 100644 index 42c5b61dd0..0000000000 --- a/modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed.adoc +++ /dev/null @@ -1,21 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="proc-starting-a-chat-in-developer-lightspeed_{context}"] -= Starting a chat with {ls-short} for the first time - -You can start a chat with {ls-short} for quick answers on a number of topics depending on your settings. You can manually start a chat with the {ls-short} or use the following sample prompts we have provided to help you get started: - -* *Getting Started with Red Hat Developer Hub* -* *Deploy with Tekton* -* *Create an OpenShift Deployment* - -.Procedure - -. In the {product-very-short} navigation menu, click *Lightspeed*. -. 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. - -.Verification -* The chat window updates to display your query and the response from {ls-short}. \ No newline at end of file diff --git a/modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc b/modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc deleted file mode 100644 index 9cddc504ca..0000000000 --- a/modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc +++ /dev/null @@ -1,16 +0,0 @@ -:_mod-docs-content-type: PROCEDURE - -[id="proc-viewing-chat-history-in-developer-lightspeed_{context}"] -= Viewing chat history in {ls-short} - -Your chats with {ls-short} are automatically saved in your {product-very-short} instance. You can easily revisit your chat history at any time, switch between chats, or resume a previous chat. - -.Procedure - -. In the {product-very-short} navigation menu, click *Lightspeed*. -{ls-short} opens with your previous chat. -. Select a chat title from the history list to view the full conversation. -. Optional: Use the *Search previous chats...* field to filter the history list by keyword. - -.Verification -* The selected conversation loads in the main window, allowing you to view the history or continue the chat. \ No newline at end of file diff --git a/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc index fdd5af46b0..70502b3082 100644 --- a/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc +++ b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc @@ -3,34 +3,35 @@ [id="proc-creating-a-software-component-using-templates_{context}"] = Creating a software component using Software Templates -You can create a software component using standard Software Templates. The scaffolding process runs in your {product} instance. +To ensure project consistency and reduce manual configuration time, use Software Templates to create new components. These templates automate the scaffolding process, providing a pre-configured project structure directly in your {product} instance. .Prerequisites * You are logged in to the {product} instance. .Procedure -. In your {product} navigation menu, click *Catalog* > *Self-service*. -. On the *Self-service* page, click *Choose* on the *Templates* tile to initiate the scaffolding process for a template. -. Follow the wizard instructions, entering the required details, and selecting from pre-defined options. -. Optional: In the *Deployment Information* step, you have an option to *Create Workbench for OpenShift AI*. +. On the {product} navigation menu, click *Catalog* > *Self-service*. +. On the *Self-service* page, locate the *Templates* tile and click *Choose* to start the scaffolding process. +. Follow the wizard instructions to enter the required project details. +. Optional: In the *Deployment Information* step, select *Create Workbench for OpenShift AI*. + [NOTE] ==== -This option is only available for certain templates. +This option is available only for certain templates. ==== -. In the *Review* step, verify the parameters you have entered and click *Create*. +. In the *Review* step, verify your parameters and click *Create*. + -The scaffolding process begins. You can view the logs during the process or click *Cancel* to abort the operation. +The scaffolding process begins. You can monitor the progress in the logs or click *Cancel* to stop the operation. .Verification -* If your software component is created successfully, a success page similar to the example in the following image appears: +* If the component is created successfully, a success page appears. + -- image::rhdh/template-creation-successful.png[template-creation-successful] -- .Troubleshooting -* If the component creation fails, review the logs on the error page. Click *Start Over* to return to the *Self-service* page while retaining your entered values. +* If the creation process fails, you must review the logs on the error page for specific failure details. +* To retry, click *Start Over*; the system retains your previously entered values on the *Self-service* page. + image::rhdh/template-creation-not-successful.png[template-creation-not-successful] \ No newline at end of file diff --git a/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc index 4d34a5dc5b..b6045e5f92 100644 --- a/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc +++ b/modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-templates.adoc @@ -15,7 +15,7 @@ Alternately, you can use the Template Editor to do any of the following actions: .Procedure -. In your {product} navigation menu, click *Catalog > Self-service*. Alternatively, to go to *Self-service* page, in your header menu, click the (+) icon. +. In your {product} navigation menu, click *Catalog > Self-service*. Alternatively, to go to the *Self-service* page, in your header menu, click the (+) icon. . Click the *More options* icon and select *Manage Templates*. + image::rhdh/template-editor.png[Template Editor] diff --git a/modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc b/modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc index 6c5a14eaf9..9d4b80c31c 100644 --- a/modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc +++ b/modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc @@ -3,10 +3,10 @@ [id="proc-searching-and-filtering-software-templates_{context}"] = Searching and filtering Software Templates in your {product} instance -You can search and filter for the Software Template to create a software component. +To quickly locate the correct configuration for your project and reduce time spent browsing the catalog, search and filter the available Software Templates. Narrowing your search ensures you select the specific template that meets your development requirements. .Procedure . In the {product} navigation menu, click *Catalog* > *Self-service*. -. In the *Search* box, enter the name of the Software Template. -. Optional: To filter results, select a category from the *Categories* dropdown list. +. In the *Search* field, enter the name for the Software Template. +. Optional: To refine the results, select a category from the *Category* list. \ No newline at end of file diff --git a/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc index 4f4a3a51ab..2d265b54bc 100644 --- a/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc +++ b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-find-docs.adoc @@ -1,27 +1,18 @@ :_mod-docs-content-type: PROCEDURE [id="proc-techdocs-find-docs_{context}"] -= Searching for relevant content in TechDocs += Searching for TechDocs -To view technical content, locate specific documents in *TechDocs* by using the search bar or filters. - -The TechDocs Documentation page displays all documentation imported into your {product} instance. You can locate documentation by using keywords or filters: - -* *Search*: Enter a keyword in the search bar to find documents containing that term. -* *Filter by Owner*: View documents owned by a specific user or group. -* *Filter by Tags*: View documents containing a specific tag. -* *Filter by Owned*: View documents owned by you or a group to which you belong. -* *Filter by Starred*: View documents you added to favorites. - -The *All* field displays the total number of documents that have been imported into TechDocs. If you search or filter, this field updates to show the number of of documents that meet the search and filter criteria that you applied. - -.Prerequisites - -* The TechDocs plugin is enabled and configured. -* Documentation is imported into TechDocs. -* You have the required roles and permissions to add and view documentation to TechDocs. +To quickly find the information required for your services, search or filter the TechDocs catalog. Narrowing your search makes sure you find relevant resources without browsing multiple repositories. .Procedure . In the {product} navigation menu, click *Docs*. -. On the *Documentation* page, use the search bar, filters, or both to locate the document that you want to view. +. On the *Documentation* page, use the search bar or filters to locate your document: +** *Search*: Enter keywords to find specific terms within documents. +** *Filter by Owner*: View documents owned by specific users or groups. +** *Filter by Tags*: Narrow results by specific labels or categories. +** *Filter by Owned*: View documents belonging to you or your group. +** *Filter by Starred*: View your bookmarked favorites. + +The results update automatically to show the number of documents that meet your criteria. \ No newline at end of file diff --git a/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc index 7c2b2c95f9..c2224e77be 100644 --- a/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc +++ b/modules/manage-and-consume-techdoc-within-rhdh/proc-techdocs-view-docs.adoc @@ -1,32 +1,16 @@ :_mod-docs-content-type: PROCEDURE [id="proc-techdocs-view-docs_{context}"] -= Accessing and reading documentation in TechDocs += Accessing and navigating documentation -In TechDocs, a document might be part of a book that contains other documents that are related to the same topic. - -Clicking the name of a document in the table on the *Documentation* page opens the document in a book page. The name of the book is displayed on the book page. - -You can use the elements on the book page to search, view, and navigate the documentation in the book. - -.Prerequisites - -* The TechDocs plugin is enabled and configured. -* Documentation is imported into TechDocs. -* You have the required roles and permissions to add and view documentation to TechDocs. -* Optional: TechDocs add-ons are installed and configured. +Use the built-in navigation tools to move between related documents within a book. This ensures you can easily reference implementation details and requirements in a logical sequence. .Procedure - . In the {product} navigation menu, click *Docs*. -. In the *Documentation* table, click the name of the document that you want to view. -. 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. - -//This xref is failing - need to check -//.Additional resources -//* xref:techdocs-addon[TechDocs add-ons] +. In the *Documentation* table, click the name of the document you want to view. +. Navigate the content using the following on-screen tools: +** *Search bar*: Find keywords within the current document. +** *Table of contents*: Jump to specific sections. +** *Navigation menu*: Switch between different documents in the same book. +** *Next*: Proceed to the next sequential document. +** *Add-ons*: Perform additional actions if plugins are configured. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/con-distinguish-rhdh-from-backstage.adoc b/modules/navigate-rhdh-on-your-first-day/con-distinguish-rhdh-from-backstage.adoc new file mode 100644 index 0000000000..a1fa1139e2 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/con-distinguish-rhdh-from-backstage.adoc @@ -0,0 +1,42 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-distinguish-rhdh-from-backstage_{context}"] += Distinguish {product-very-short} from {backstage} + +While {product-very-short} is built on the open-source {backstage} project, it offers distinct advantages for enterprise environments. {product-very-short} is a production-ready, supported distribution that removes the maintenance burden associated with the upstream project. + +.Operational comparison + +Use the following comparison to determine which platform aligns with your team's maintenance capacity and security requirements. + +[cols="1,2,2", options="header"] +|=== +| Feature +| {backstage} +| {product-very-short} + +| *Maintenance Model* +| Requires manual codebase maintenance and frequent manual upgrades. +| Uses a zero-code model where {company-name} manages the base image and updates. + +| *Support* +| Community-based support through forums and documentation. +| Provides 24x7 enterprise-level support. + +| *Plugin Architecture* +| Requires recompilation of the entire application to add or update plugins. +| Uses a dynamic plugin architecture to allow updates without recompilation. + +| *Security* +| Requires self-managed security patching and custom RBAC implementation. +| Includes built-in Role-Based Access Control (RBAC) and rapid CVE resolution. + +| *Deployment* +| Uses a standard Helm-based installer. +| Uses a Kubernetes Operator-based installer for OpenShift and major cloud providers. +|=== + +.Choosing a platform for your organization + +* *Choose {backstage} if:* Your organization has a dedicated platform engineering team to manage source code, implement security patches, and build custom integrations. +* *Choose {product-very-short} if:* You need a production-ready portal that prioritizes security and stability while allowing your team to focus on development tasks rather than platform maintenance. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/con-leverage-rhdh-capabilities-for-daily-productivity.adoc b/modules/navigate-rhdh-on-your-first-day/con-leverage-rhdh-capabilities-for-daily-productivity.adoc new file mode 100644 index 0000000000..d404345f3e --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/con-leverage-rhdh-capabilities-for-daily-productivity.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-leverage-rhdh-capabilities-for-daily-productivity_{context}"] += Leverage {product-very-short} capabilities for daily productivity + +To streamline your software development lifecycle, use the integrated toolset within {product} ({product-very-short}). These core capabilities allow you to perform self-service tasks and discover organizational resources from a centralized interface. + +.Developer workflow capabilities + +By using the following features, you can reduce context switching and automate repetitive setup tasks: + +Software Catalog:: +Use this centralized inventory to manage software components, APIs, and systems. You can visualize ownership, track dependencies, and monitor the lifecycle status of assets across the organization. + +Software Templates:: +Automate the creation of new projects by using self-service templates. These templates bootstrap repositories, configure CI/CD pipelines, and apply organizational best practices to eliminate manual configuration. + +TechDocs:: +Access "docs-as-code" documentation that renders directly within the portal. This ensures that technical guides remain synchronized with the codebase and are easily discoverable alongside their corresponding services. + +Plugins:: +Extend the portal's functionality by connecting it to your existing toolchain. You can monitor *ArgoCD* deployments, view *Jira* tickets, or review *Quay* registry scans without navigating away from the portal interface. + +Global Search:: +Find specific components, documentation, or team members instantly by using a unified search engine that indexes the entire software ecosystem. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/con-navigate-the-rhdh-interface.adoc b/modules/navigate-rhdh-on-your-first-day/con-navigate-the-rhdh-interface.adoc new file mode 100644 index 0000000000..d7617d0ac8 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/con-navigate-the-rhdh-interface.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-navigate-the-rhdh-interface_{context}"] += Navigate the {product-very-short} interface + +To locate resources, manage projects, and customize your workspace, use the two primary navigation areas in {product} ({product-very-short}). By understanding these regions, you can navigate the software ecosystem and execute development tasks efficiently. + +.Using the Global Header +The top bar provides immediate access to high-frequency actions and personal settings. + +* *Search*: Use the input field to find components, APIs, documentation, and users across the entire ecosystem instantly. +* *Self-service (+)*: Select the plus icon to access templates for creating new software components or projects. +* *User profile*: Click your avatar to adjust interface settings, set appearance preferences (such as *Dark Mode*), or log out. +* *Support and notifications*: Access system alerts and platform help resources. + +.Using the left navigation sidebar +The sidebar organizes core platform features into distinct functional sections. + +* *Home*: Navigate to your personalized dashboard to view recently accessed items and team updates. +* *Catalog*: Browse the inventory of software components, services, and resources to visualize ownership and dependencies. +* *Docs*: Access the technical documentation library (*TechDocs*) to read guides linked to specific software entities. +* *APIs*: Explore and test available API definitions in the centralized browser. +* *Create*: Open the template gallery to scaffold new projects using organizational "golden paths". \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/con-prepare-your-first-rhdh-for-production.adoc b/modules/navigate-rhdh-on-your-first-day/con-prepare-your-first-rhdh-for-production.adoc new file mode 100644 index 0000000000..392c6d310e --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/con-prepare-your-first-rhdh-for-production.adoc @@ -0,0 +1,38 @@ +:_mod-docs-content-type: CONCEPT + +[id="con-prepare-your-first-rhdh-for-production_{context}"] += Prepare your first {product-very-short} for 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. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-analyzing-microservice-dependencies-and-status.adoc b/modules/navigate-rhdh-on-your-first-day/proc-analyzing-microservice-dependencies-and-status.adoc new file mode 100644 index 0000000000..3d4975a959 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-analyzing-microservice-dependencies-and-status.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-analyzing-microservice-dependencies-and-status_{context}"] += Analyzing microservice dependencies and status to improve performance + +To identify backend applications and microservices, view their deployment status, and understand their API relationships, use the filters in the {product} ({product-very-short}) Software Catalog. Filtering for services ensures you can verify architectural connections and ownership without manually tracing code across disparate repositories. + +.Procedure + +. Navigate to the {product-very-short} interface. +. In the left navigation sidebar, click *Catalog*. +. Click the *Kind* filter and select *Component*. +. Click the *Type* filter and select *Service*. +. Optional: Narrow the list by selecting a specific *Owner* or *Lifecycle*, such as `production` or `experimental`. +. Select a service card to open the detailed entity view. +. Review the *Overview* tab to identify the assigned owner and access links to the source code repository. +. Select the *Dependencies* or *Relations* tab to see upstream and downstream connections for that service. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-browsing-the-extensions-marketplace.adoc b/modules/navigate-rhdh-on-your-first-day/proc-browsing-the-extensions-marketplace.adoc new file mode 100644 index 0000000000..7f0ce4e0ce --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-browsing-the-extensions-marketplace.adoc @@ -0,0 +1,18 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-browsing-the-extensions-marketplace_{context}"] += Identifying integrations in the {product-very-short} extensions marketplace + +To enhance your development workflow with additional tools, browse the extensions marketplace in {product} ({product-very-short}). Identifying available plugins allows you to see which integrations are currently active or which supported tools your team can request to improve project visibility and automation. + +.Procedure + +. In the left navigation sidebar, click *Extensions*. +. 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. + +[NOTE] +==== +End users typically cannot install plugins. If you locate a plugin in the marketplace or the Backstage Plugin Directory that your team requires, contact your administrator to request its enablement. +==== \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-discovering-global-plugins.adoc b/modules/navigate-rhdh-on-your-first-day/proc-discovering-global-plugins.adoc new file mode 100644 index 0000000000..46c0b97e34 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-discovering-global-plugins.adoc @@ -0,0 +1,15 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-discovering-global-plugins_{context}"] += Accessing platform-wide tools using global plugins + +To manage technology standards, track project costs, or access AI assistance, use the global plugins located in the main navigation sidebar of {product} ({product-very-short}). These plugins provide features that apply across the entire portal rather than to a specific software entity. + +.Procedure + +. Log in to your {product-very-short} instance. +. 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. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-filtering-and-refining-search-results.adoc b/modules/navigate-rhdh-on-your-first-day/proc-filtering-and-refining-search-results.adoc new file mode 100644 index 0000000000..33ff2c02c8 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-filtering-and-refining-search-results.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-filtering-and-refining-search-results_{context}"] += Filtering and refining search results + +To isolate specific components, APIs, or documentation within a large software ecosystem, use the advanced search filters in {product} ({product-very-short}). Refining your search results ensures you can locate production-ready services and ownership details without navigating through unrelated resources. + +.Procedure + +. Enter your query in the *Search* bar in the Global Header. +. Click the *All results...* link at the bottom of the results dropdown menu. +. 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*. +. Review the filtered results to identify the description and owner of the resource. +. Optional: Use the pagination controls at the bottom of the page to navigate through large result sets. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-locating-components-in-rhdh.adoc b/modules/navigate-rhdh-on-your-first-day/proc-locating-components-in-rhdh.adoc new file mode 100644 index 0000000000..f782e889f8 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-locating-components-in-rhdh.adoc @@ -0,0 +1,15 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-locating-components-in-rhdh_{context}"] += Locating production-ready components in {product-very-short} + +To identify existing software building blocks, view source code, or check lifecycle status, use the catalog filters in {product} ({product-very-short}). Filtering the catalog ensures you can locate production-ready components and documentation without performing manual searches across multiple repositories. + +.Procedure + +. Navigate to the {product-very-short} interface. +. In the left navigation sidebar, click *Catalog*. +. Click the *Kind* filter and select *Component*. +. Optional: Click the *Type* filter to narrow the list to a specific functional category, such as *Library*, *Website*, or *Tool*. +. Enter the component name in the *Search* bar at the top of the *Catalog* page. +. Select the component card from the results to view its *Overview*, *Docs*, and *Relationships*. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-locating-resources-instantly.adoc b/modules/navigate-rhdh-on-your-first-day/proc-locating-resources-instantly.adoc new file mode 100644 index 0000000000..212a43c11b --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-locating-resources-instantly.adoc @@ -0,0 +1,13 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-locating-resources-instantly_{context}"] += Locating resources instantly + +To bypass menu navigation and locate technical assets quickly, use the universal search bar in {product} ({product-very-short}). The search engine provides real-time suggestions to help you navigate directly to services, documentation, or team members, which reduces the time spent searching across disparate repositories. + +.Procedure + +. Click the *Search* input field in the Global Header. +. Enter your query, such as a service name, API endpoint, or technical concept. +. Review the instant results in the dropdown menu, which categorize matches by entity types such as *Components*, *APIs*, *TechDocs*, and *Users*. +. Select a suggestion from the list to navigate directly to that resource. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-logging-in-to-rhdh.adoc b/modules/navigate-rhdh-on-your-first-day/proc-logging-in-to-rhdh.adoc new file mode 100644 index 0000000000..199d154441 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-logging-in-to-rhdh.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-logging-in-to-rhdh_{context}"] += Logging in to {product-very-short} + +To access your organization's software ecosystem, tools, and self-service templates, log in to the {product} ({product-very-short}) web console. With a successful login, you can access resources permitted by your role-based access control (RBAC) settings. + +.Procedure + +. Navigate to the {product-very-short} URL provided by your administrator. +. 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. +==== +. Enter your credentials and complete the required authentication prompts. + +.Verification + +* The portal redirects you to the *Home* page. +* Your personalized dashboard appears, displaying your username and recently accessed items. diff --git a/modules/navigate-rhdh-on-your-first-day/proc-personalizing-navigation-experience.adoc b/modules/navigate-rhdh-on-your-first-day/proc-personalizing-navigation-experience.adoc new file mode 100644 index 0000000000..0b367943d2 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-personalizing-navigation-experience.adoc @@ -0,0 +1,30 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-personalizing-navigation-experience_{context}"] += Personalizing the navigation experience in {product-very-short} + +To reduce navigation time and tailor the portal to your working environment, personalize the {product} ({product-very-short}) interface. Customizing your sidebar, theme, and shortcuts ensures that high-priority resources remain accessible throughout your development lifecycle. + +.Prerequisites + +* You are logged in to the {product} console. + +.Procedure + +. Configure interface settings: +.. Click your avatar in the Global Header and select *Settings*. +.. Enable *Pin Sidebar* to keep the navigation menu expanded, or disable it to maximize your primary workspace area. +.. In the *Appearance* section, select *Light*, *Dark*, or *Auto* to synchronize the portal theme with your system preferences. + +. Create shortcuts (favorites) for frequent resources: +.. Navigate to the specific component, API, or documentation page you use daily. +.. Click the *Star* (*) icon near the page title to add it to your favorites. +.. Access these shortcuts instantly by selecting the *Star* icon in the Global Header. + +.Troubleshooting navigation + +If you cannot locate a specific resource: + +* Enter the resource name in the *Search* field in the Global Header. +* Navigate to the *Catalog* and clear any active filters that might be hiding the entity. +* Click the *Support* icon in the Global Header to contact your platform administrator. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-reviewing-api-contracts.adoc b/modules/navigate-rhdh-on-your-first-day/proc-reviewing-api-contracts.adoc new file mode 100644 index 0000000000..c9275f862f --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-reviewing-api-contracts.adoc @@ -0,0 +1,19 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-reviewing-api-contracts_{context}"] += Reviewing API contracts to verify service endpoints and schemas + +To verify endpoints, schemas, and server URLs for your services, locate and inspect API contracts in {product} ({product-very-short}). Reviewing these definitions allows you to validate required parameters and data models in a rendered format without manually searching through source code repositories. + +.Procedure + +. Navigate to the {product-very-short} interface. +. In the left navigation sidebar, click *APIs*. ++ +[NOTE] +==== +You can also find these resources by clicking *Catalog* and selecting *API* from the *Kind* filter. +==== +. Select an API from the list to open the detail view. +. Select the *Overview* tab to examine the metadata, assigned owner, and lifecycle status. +. Select the *Definition* tab to view the rendered specification, such as an interactive Swagger or AsyncAPI interface. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-reviewing-rhdh-resource-data.adoc b/modules/navigate-rhdh-on-your-first-day/proc-reviewing-rhdh-resource-data.adoc new file mode 100644 index 0000000000..0154427361 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-reviewing-rhdh-resource-data.adoc @@ -0,0 +1,21 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-reviewing-rhdh-resource-data_{context}"] += Reviewing {product-very-short} resource data + +To review data specific to a particular resource in {product-very-short}, use entity plugins that appear when viewing components, services, or APIs in the Software Catalog. + +.Procedure + +. Navigate to the {product-very-short} interface. +. In the left navigation sidebar, click *Catalog*. +. Select a *Component* or *Service* card. +. 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. + +.Next steps + +* If a build fails in the *CI/CD* tab, select the build number to view the logs in the source provider. +* If a pod is failing in the *Kubernetes* tab, examine the error events to troubleshoot the deployment. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/proc-validating-api-endpoints.adoc b/modules/navigate-rhdh-on-your-first-day/proc-validating-api-endpoints.adoc new file mode 100644 index 0000000000..eeb6650c40 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/proc-validating-api-endpoints.adoc @@ -0,0 +1,23 @@ +:_mod-docs-content-type: PROCEDURE + +[id="proc-validating-api-endpoints_{context}"] += Verifying service integration using interactive API testing + +To verify API behavior and debug service responses, use the interactive test interface in {product} ({product-very-short}). Validating endpoints directly within the portal ensures they return the expected status codes and data models, which eliminates the need to configure external testing tools during the initial integration phase. + +.Prerequisites + +* You have the required credentials or tokens if the API requires authentication. + +.Procedure + +. Navigate to the specific API you must validate and select the *Definition* tab. +. Locate the operation you want to verify and select the header to expand the details. +. Click *Try it out* to enable the interactive input fields. +. Enter the required parameters or the request body JSON in the provided fields. +. Click *Execute*. +. Examine the *Server response* section to verify the status code, response body, and headers. +[NOTE] +==== +If you receive 401 (Unauthorized) or 403 (Forbidden) errors, you must verify your credentials with the API owner or check the authorization header requirements in the specification. +==== \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/ref-access-tools-and-search-using-global-header.adoc b/modules/navigate-rhdh-on-your-first-day/ref-access-tools-and-search-using-global-header.adoc new file mode 100644 index 0000000000..c9376f5329 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/ref-access-tools-and-search-using-global-header.adoc @@ -0,0 +1,26 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-access-tools-and-search-using-global-header_{context}"] += Access tools and search using the Global Header + +To execute common tasks and manage your environment without interrupting your workflow, use the tools in the Global Header of {product} ({product-very-short}). The header provides centralized access to search, self-service tools, and personal configuration options. + +.Global Header tools + +Search Input Field:: +Use this universal search bar to query components, APIs, documentation, and users across the entire organization. The search engine provides real-time suggestions to help you navigate directly to a resource. + +Self-Service (+):: +Select this quick-action button to open the template browser. From this menu, you can bootstrap new projects using "Golden Path" templates or register existing components into the Software Catalog. + +Support:: +Access your organization's internal help resources, such as ticketing systems, developer guides, or community chat channels. + +Notifications:: +View the alert center for updates regarding plugin status, external service health, or changes in your workflow or task assignments. + +User Profile:: +Open this dropdown menu by selecting your avatar to manage interface settings, view platform version information, or end your session. + +Quick Links:: +Access a curated set of links to external applications required for your development lifecycle, such as CI/CD pipelines, monitoring dashboards, or project management tools. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/ref-authentication-methods.adoc b/modules/navigate-rhdh-on-your-first-day/ref-authentication-methods.adoc new file mode 100644 index 0000000000..b9e3968317 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/ref-authentication-methods.adoc @@ -0,0 +1,25 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-authentication-methods_{context}"] += Authentication methods to enable self-service capabilities + +To access the specific tools, repositories, and permissions assigned to your role, you must authenticate to {product} ({product-very-short}) using a supported provider. Selecting the correct authentication method ensures that the portal correctly associates your identity with your team's software components and self-service capabilities. + +.Common authentication methods: + +Corporate Single Sign-On (SSO):: +Select this option to use your standard organizational credentials. This method typically provides full access to internal resources and links your portal identity to your official team membership. + +Federated authentication:: +Use services such as *Keycloak* or *Ping Federate* to unify your login across multiple enterprise applications. This ensures that your permissions remain consistent as you navigate between the portal and external development tools. + +OAuth providers:: +Select providers such as GitHub, GitLab, or *Azure DevOps* to link your developer identity directly to the portal. This is required if you need to perform actions in the *Software Catalog* that involve external version control systems. + +Guest access:: +Use this restricted, read-only mode for initial platform exploration. ++ +[IMPORTANT] +==== +*Guest access* is intended for demonstration purposes. While in this mode, you cannot register components, use *Software Templates*, or access restricted organizational data. +==== \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/ref-browse-core-resources-using-the-left-sidebar.adoc b/modules/navigate-rhdh-on-your-first-day/ref-browse-core-resources-using-the-left-sidebar.adoc new file mode 100644 index 0000000000..d2d7150adf --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/ref-browse-core-resources-using-the-left-sidebar.adoc @@ -0,0 +1,31 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-browse-core-resources-using-the-left-sidebar_{context}"] += Browse core resources using the left sidebar + +To discover tools, manage catalogs, and access technical documentation without switching contexts, use the left navigation sidebar in {product} ({product-very-short}). The sidebar organizes platform resources into functional sections that allow you to locate the specific services and APIs required for your development tasks. + +.Standard navigation items + +Home:: +Navigate to your personalized dashboard to view recently accessed resources, team activity, and tailored quickstart guides. + +Catalog:: +Access the centralized inventory of all software assets. Use this section to browse and filter components, services, and systems to understand their ownership and operational health. + +Docs:: +Access the *TechDocs* library to read technical guides and runbooks that are synchronized with the source code of your organization's services. + +APIs:: +Discover and test API definitions. Use this section to inspect OpenAPI or AsyncAPI specifications and verify endpoints directly in the browser. + +Administration:: +(Restricted) Access platform configuration tools. This section is visible primarily to platform engineers for managing users, permissions, and plugin settings. + +.Extended sidebar items + +As your organization enables additional plugins to support your workflow, more items might appear in the sidebar: + +* *Learning Paths*: Access training modules and educational resources to develop new technical skills. +* *Tech Radar*: Review your organization's official technology recommendations and standards. +* *Cost Insights*: Monitor the cloud infrastructure costs associated with your specific services or teams. \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/ref-get-the-best-results-for-assistant-queries.adoc b/modules/navigate-rhdh-on-your-first-day/ref-get-the-best-results-for-assistant-queries.adoc new file mode 100644 index 0000000000..d74fe3a97a --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/ref-get-the-best-results-for-assistant-queries.adoc @@ -0,0 +1,28 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-get-the-best-results-for-assistant-queries_{context}"] += Get the best results for assistant queries + +To resolve technical blockers and accelerate development tasks, you must structure your queries to provide specific context to the AI assistant. Using precise prompts ensures that {ls-short} generates relevant code snippets, architectural advice, or platform-specific instructions. + +Use the following strategies to improve the accuracy of the assistant's output during your development workflow: + +Specify technologies:: +Instead of asking "How do I use templates?", ask "How do I create a Software Template that scaffolds a Node.js service with a CI/CD pipeline". + +Provide context:: +Include details about your environment, such as "I am deploying to OpenShift; how do I configure my catalog-info.yaml to show pod health?". + +Leverage conversation context:: +Ask follow-up questions to refine a previous answer. For example, if the assistant provides a code snippet, you can ask "Now rewrite that using TypeScript interfaces." + +Validate with citations:: +Examine the provided documentation links and citations in the response to verify that the generated advice aligns with your organization's official standards. + +Improve assistant accuracy:: +Rate the utility of responses by selecting the **Thumbs up** or **Thumbs down** icons. This feedback helps tune the model for your organization's specific requirements. + +[IMPORTANT] +==== +To maintain security standards, do not include sensitive personal information, plain-text credentials, or confidential business data in your queries. +==== \ No newline at end of file diff --git a/modules/navigate-rhdh-on-your-first-day/ref-supported-api-specifications.adoc b/modules/navigate-rhdh-on-your-first-day/ref-supported-api-specifications.adoc new file mode 100644 index 0000000000..6885597ed4 --- /dev/null +++ b/modules/navigate-rhdh-on-your-first-day/ref-supported-api-specifications.adoc @@ -0,0 +1,17 @@ +:_mod-docs-content-type: REFERENCE + +[id="ref-supported-api-specifications_{context}"] += Select supported API specifications + +To ensure your API definitions are discoverable and interactive within the {product} ({product-very-short}) portal, you must use a supported specification format. Selecting the appropriate format based on your service architecture allows the platform to render documentation and provide testing interfaces for other developers. + +.Supported API formats + +* OpenAPI: Use this standard format (formerly Swagger) for defining RESTful APIs. {product-very-short} renders these specifications into interactive documentation, allowing users to execute requests directly from the *Definition* tab. +* AsyncAPI: Use this format for event-driven architectures and message-based services. This ensures that producers and consumers can visualize message schemas and broker details within the *Software Catalog*. +* GraphQL: Use this format to define GraphQL schemas. This allows developers to explore your data graph, including queries, mutations, and types, from a centralized location. + +[NOTE] +==== +Support for specific formats, such as *AsyncAPI* or *GraphQL*, depends on your organization's instance configuration and enabled plugins. If a specification does not render, verify your `catalog-info.yaml` metadata or contact your platform administrator. +==== \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/artifacts b/titles/navigate-rhdh-on-your-first-day/artifacts new file mode 120000 index 0000000000..04f3a24af5 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/artifacts @@ -0,0 +1 @@ +../../artifacts/ \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/assemblies b/titles/navigate-rhdh-on-your-first-day/assemblies new file mode 120000 index 0000000000..51bb510220 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/assemblies @@ -0,0 +1 @@ +../../assemblies/ \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/docinfo.xml b/titles/navigate-rhdh-on-your-first-day/docinfo.xml new file mode 120000 index 0000000000..fecb543b13 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/docinfo.xml @@ -0,0 +1 @@ +../../artifacts/docinfo.xml \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/images b/titles/navigate-rhdh-on-your-first-day/images new file mode 120000 index 0000000000..847b03ed05 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/images @@ -0,0 +1 @@ +../../images/ \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/master.adoc b/titles/navigate-rhdh-on-your-first-day/master.adoc new file mode 100644 index 0000000000..c775ac9746 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/master.adoc @@ -0,0 +1,32 @@ +include::artifacts/attributes.adoc[] +:title: Navigate {product} on your first day +:subtitle: Log in, navigate the {product} ({product-very-short}) interface, and personalize your workspace to become productive immediately. +:abstract: As a new developer, you will learn how to personalize your experience by customizing settings and starring frequently used items, enabling you to independently find the software catalog, templates, and documentation you need. +:context: quickly-gain-access-and-find-what-you-need-in-rhdh +:optional-steps: disable +[id="{context}"] += {title} + +{abstract} + +include::assemblies/assembly-purpose-and-structure-of-rhdh.adoc[leveloffset=+1] + +include::assemblies/assembly-log-in-rhdh.adoc[leveloffset=+1] + +include::assemblies/assembly-locate-software-components-to-discover-assets.adoc[leveloffset=+1] + +include::assemblies/assembly-import-and-use-an-existing-template-for-faster-development.adoc[leveloffset=+1] + +include::assemblies/assembly-finding-and-viewing-techdocs.adoc[leveloffset=+1] + +include::assemblies/assembly-verify-api-contracts-before-integration.adoc[leveloffset=+1] + +include::assemblies/assembly-locate-resources-and-documentation-using-search.adoc[leveloffset=+1] + +include::assemblies/assembly-using-developer-lightspeed.adoc[leveloffset=+1] + +include::assemblies/assembly-integrate-and-customize-your-daily-tools-using-extensions.adoc[leveloffset=+1] + +include::assemblies/assembly-customize-interface-settings.adoc[leveloffset=+1] + +include::assemblies/assembly-managing-starred-items-for-quick-access.adoc[leveloffset=+1] \ No newline at end of file diff --git a/titles/navigate-rhdh-on-your-first-day/modules b/titles/navigate-rhdh-on-your-first-day/modules new file mode 120000 index 0000000000..36719b9de7 --- /dev/null +++ b/titles/navigate-rhdh-on-your-first-day/modules @@ -0,0 +1 @@ +../../modules/ \ No newline at end of file