Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ include::modules/centralizing-your-software-components-in-rhdh/proc-registering-

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

include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc[leveloffset=+1]
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-components-by-kind-in-the-rhdh-catalog.adoc[leveloffset=+1]

include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc[leveloffset=+1]
include::modules/centralizing-your-software-components-in-rhdh/proc-filtering-components-by-text-in-the-rhdh-catalog.adoc[leveloffset=+1]

include::modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ include::modules/importing-and-using-an-existing-template-for-faster-development

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-new-software-component-using-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]

Expand Down
56 changes: 27 additions & 29 deletions assemblies/assembly-using-developer-lightspeed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,27 @@

:context: Using-developer-lightspeed

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

.Capabilities

Check warning on line 16 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [AsciiDocDITA.BlockTitle] Block titles can only be assigned to examples, figures, and tables in DITA. Raw Output: {"message": "[AsciiDocDITA.BlockTitle] Block titles can only be assigned to examples, figures, and tables in DITA.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 16, "column": 1}}}, "severity": "WARNING"}
The scope of questions you can ask depends on your configuration:

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

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

Check warning on line 23 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term. Raw Output: {"message": "[RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 23, "column": 9}}}, "severity": "WARNING"}
** “How do I install plugins on {product}?”

Check warning on line 24 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term. Raw Output: {"message": "[RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 24, "column": 12}}}, "severity": "WARNING"}

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

** “Analyze this log for me…”
** “Suggest libraries and frameworks I can use to build Event Driven Architecture microservices.”

Check warning on line 29 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term. Raw Output: {"message": "[RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 29, "column": 38}}}, "severity": "WARNING"}
** “I'm not familiar with this language, so explain to me what this code snippet is doing…”

Check warning on line 30 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term. Raw Output: {"message": "[RedHat.TermsWarnings] Consider using 'you' rather than 'I' unless updating existing content that uses the term.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 30, "column": 5}}}, "severity": "WARNING"}
** “Create a Kubernetes deployment for this service…”
** “Create a test plan for the following scenarios and conditions…”
** “Create a Jira record that describes the following feature…”
** “Draft the end-user documentation describing how to use the following cli command…”

Check warning on line 34 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

[vale] reported by reviewdog 🐶 [RedHat.Spelling] Verify the word 'cli'. It is not in the American English spelling dictionary used by Vale. Raw Output: {"message": "[RedHat.Spelling] Verify the word 'cli'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "assemblies/assembly-using-developer-lightspeed.adoc", "range": {"start": {"line": 34, "column": 74}}}, "severity": "WARNING"}

[NOTE]
====
Expand All @@ -22,36 +42,14 @@
* `External_providers_dir` set to `null`
====

With `Question Validation` enabled, you can ask {ls-short} the following types of questions:

* “Tell me about {product}.”

* “What are the benefits of {product-very-short}?”

* “Can I use {product-very-short} on an {ocp-short}?”

* “How do I install plugins on {product}?”

With `Question Validation` disabled, the scope of prompts you can put to {ls-short} is much broader. This allows {ls-short} to support you in a much more varied range of work situations as described in the following examples:

* “Analyze this log for me…”

* “Suggest libraries and frameworks I can use to build Event Driven Architecture microservices.”

* “I'm not familiar with this language, so explain to me what this code snippet is doing…”

* “Create a Kubernetes deployment for this service…”

* “Create a test plan for the following scenarios and conditions…”

* “Create a Jira record that describes the following feature…”
.Prerequisites

Check warning on line 45 in assemblies/assembly-using-developer-lightspeed.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale

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

* “Draft the end-user documentation describing how to use the following cli command…”
* You have the {ls-short} plugin configured in your {product-very-short} instance.

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

include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-create-new-chats-after-the-first-chat.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-using-developer-lightspeed-to-view-chat-history.adoc[leveloffset=+1]
include::modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc[leveloffset=+1]

include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-delete-a-chat.adoc[leveloffset=+1]
include::modules/developer-lightspeed/proc-deleting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
// Module included in the following assemblies:
//
// * assemblies/assembly-about-software-catalogs.adoc
:_mod-docs-content-type: PROCEDURE
[id="proc-filtering-components-by-text-in-the-rhdh-catalog_{context}"]
= Filtering components by text in the {product} Catalog

Use this procedure to search and filter components by text in the Software Catalog.

.Procedure
. In your {product} navigation menu, click *Catalog*.
. In the *Search* field, enter a component name, description, or keyword that you are looking for.

.Verification
* The *Catalog* list updates to display only components matching your search criteria.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_mod-docs-content-type: PROCEDURE
[id="proc-finding-components-by-kind-in-the-rhdh-catalog_{context}"]
= Finding components by Kind in the {product} catalog

Use this procedure to filter the Software Catalog to display components by their type.

.Prerequisites
* You are logged in to the {product-very-short} instance.

.Procedure
. In your {product} navigation menu, click *Catalog*.
. On the *Catalog* page, click the *Kind* drop-down list.
. Select the *Kind* you want to filter by, such as *Component*, *API*, or *Template*.
+
[NOTE]
====
The available filter lists change based on the *Kind* you select, showing options relevant to that entity type.
====

.Verification
* The Catalog updates to list only the components matching the selected *Kind*.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,14 @@
[id="proc-starring-key-components-in-the-software-catalog_{context}"]
= Starring key components in the Software Catalog


You can use the *Add to favorites* icon to add the software catalogs that you visit regularly to the *Starred* category.
You can add frequently used components to the *Your Starred Entities* card for quick access.

.Procedure

To quickly access the Software Catalogs that you visit regularly, complete the following steps:

. In your {product} navigation menu, click *Catalog*.
. Find the software component that you want to add as a favorite, under *Actions*, click the *Add to favorites* icon.
. In the {product} navigation menu, select *Catalog*.
. Locate the components you want to add as a favorite.
. In the *Actions* column for that component, click the *Add to favorites* (star) icon.

.Verification

* The starred component is listed under *Your Starred Entities* on your *Home* page.
* Navigate to the *Home* page and verify the component is listed in the *Your Starred Entities* card.
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
:_mod-docs-content-type: CONCEPT

[id="con-about-rhdh-sidebar-menuitems_{context}"]
= About the sidebar menu items for your {product-short} instance
= Understand the sidebar menu items for your {product-very-short} instance

The sidebar menu in {product} consists of two main parts that you can configure:
The {product-very-short} sidebar menu provides navigation through the following two distinct sections:

Dynamic plugin menu items:: Your preferences and your active plugins define dynamically one part of the sidebar menu.
Main menu items:: The core navigation structure of sidebar is static.
Main menu items:: Consists of the core navigation structure, such as *Catalog* and *Templates*. These items are static and appear for all users.

* *Dynamic plugin menu items*: These items are displayed beneath the main menu and can be customized based on the plugins installed. The main menu items section is dynamic and can change based on your preferences and installed plugins.
Dynamic plugin menu items:: Consists of items that are generated dynamically based on your installed plugins and configuration preferences. These items appear beneath the main menu.
20 changes: 8 additions & 12 deletions modules/customizing-the-appearance/con-language-persistence.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,21 @@
[id="con-language-persistence_{context}"]
= Language persistence

When you change the language in the UI, your preference is saved to storage. On next login or refresh, your chosen language setting is restored. Guest users cannot persist language preferences.
The {product-very-short} UI persists your language selection to storage, restoring it on your next login or refresh. Guest users cannot persist language preferences.

Default language selection uses the following priority order:
.Language selection priority
The system determines the default language using the following priority order:

. *Browser language priority*: The system first checks the user's browser language preferences to provide a personalized experience.

. *Configuration priority*: If no browser language matches the supported locales, the `defaultLocale` from the `i18n` configuration is used as a fallback.

. *Fallback priority*: If neither browser preferences nor configuration provide a match, defaults to `en`.

{product} automatically saves and restores user language settings across browser sessions. This feature is enabled by default and uses database storage. To opt-out and use browser storage instead, add the following to your `{my-app-config-file}` configuration file:
.Storage configuration
By default, {product} saves language settings to the database (`database`) and restores user language settings across browser sessions. You can alternatively configure the system to use browser local storage (`browser`) instead.

[source,yaml,subs="+quotes"]
----
# Example configuration for browser storage
userSettings:
persistence: browser
----

where:

userSettings:persistence::
Enter `browser` to opt-out and use browser local storage. Optionally, set this value to `database` to persist across browsers and devices. This is the default setting and does not require this configuration to be set.

----
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[id="proc-customize-rhdh-language_{context}"]
= Customizing the language for your {product-short} instance

The language settings of {product-very-short} use English by default. You can choose to use one of the following languages instead.
The {product-very-short} interface defaults to English but you can switch to another supported language.

.Supported languages
* English
Expand All @@ -16,11 +16,11 @@ English and French are the supported languages in {product-very-short} 1.8. You

.Prerequisites

* You are logged in to the {product-short} web console.
* You are logged in to the {product-very-short} web console.

.Procedure

. From the {product-short} web console, click *Settings*.
. From the *Appearance* panel, click the language dropdown to select your language of choice.
. From the *Appearance* panel, click the language dropdown to select your preferred language.
+
image::rhdh/customize-language-dropdown.png[]
Original file line number Diff line number Diff line change
@@ -1,33 +1,33 @@
:_mod-docs-content-type: PROCEDURE

[id="proc-customizing-rhdh-theme-mode_{context}"]
= Customizing the theme mode for your {product-short} instance
= Switching the theme mode for your {product-short} instance

You can choose one of the following theme modes for your {product-short} instance:
You can switch the {product-very-short} interface between the following modes:

* *Light*
* *Dark*
* *Auto*
* *Auto* (Default, matches your system preference)

[NOTE]
====
In {product-short}, theme configurations are used to change the look and feel of different UI components. So, you might notice changes in different UI components, such as buttons, tabs, sidebars, cards, and tables along with some changes in background color and font used on the {product-very-short} pages.
In {product-very-short}, theme configurations are used to change the look and feel of different UI components. So, you might notice changes in different UI components, such as buttons, tabs, sidebars, cards, and tables along with some changes in background color and font used on the {product-very-short} pages.
====

The default theme mode is *Auto*, which automatically sets the light or dark theme based on your system preferences.

.Prerequisites

* You are logged in to the {product-short} web console.
* You are logged in to the {product-very-short} web console.

.Procedure

. From the {product-short} web console, click *Settings*.
. From the *Appearance* panel, click *Light*, *Dark*, or *Auto* to change the theme mode.
. From the *Appearance* panel, select *Light*, *Dark*, or *Auto* to change the theme mode.
+
image::user-guide/custom-theme-mode-1.png[]

// [NOTE]
// ====
// If you choose the *AUTO* theme mode, ...
// ====
.Verification
* The interface immediately updates to reflect the selected theme.
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
:_mod-docs-content-type: PROCEDURE

[id="proc-deleting-a-chat-in-developer-lightspeed_{context}"]
= Deleting a chat in {ls-short}

You can remove specific chats from your chat history in {ls-short}.

.Prerequisites

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

.Procedure

. In your {product-very-short} navigation menu, click *Lightspeed*.
{ls-short} opens with your previous chat.
. In {ls-short}, click the vertical ellipsis (⋮) next to the chat title you want to remove.
. Select *Delete*.

.Verification
* The chat title is removed from the history list.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
:_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*.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
:_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}.

This file was deleted.

This file was deleted.

Loading