Skip to content
Merged
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
2 changes: 1 addition & 1 deletion _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
:ols-full: Red Hat OpenShift Lightspeed
//Lightspeed
:ols-offical: Red Hat OpenShift Lightspeed
:ols-long: Openshift Lightspeed
:ols-long: OpenShift Lightspeed
:ols-short: Lightspeed
:ols-release: Developer Preview
//LLM
Expand Down
4 changes: 2 additions & 2 deletions contributing_to_docs/term_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ Usage: single-node OpenShift

Single-node OpenShift (or {product-title} on a single-node cluster) is a deployment footprint that provides control plane and worker node capabilities in a single server for deployments in constrained environments.

Do not use: Single Node Openshift (SNO).
Do not use: Single Node OpenShift (SNO).

''''
=== three-node OpenShift
Expand All @@ -664,7 +664,7 @@ Usage: three-node OpenShift

Three-node OpenShift is a compact cluster deployment footprint on three nodes for deployments in constrained environments. It provides three control plane nodes that you configure as schedulable for workloads.

Do not use: Three Node Openshift.
Do not use: Three Node OpenShift.

''''
=== SkyDNS
Expand Down
2 changes: 1 addition & 1 deletion modules/ols-about-azure-openai.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

To use {azure-openai} with {ols-full}, you must have access to {azure-openai}. If you have already applied for and received access to {azure-openai}, you can ignore the rest of the information in this topic.

{azure-openai} access currently requires an approval process initiated from within the {azure-full} portal. When you create an {azure-openai} instance, you may see a warning that contains a link. The link in the warning will take you to the link:https://customervoice.microsoft.com/Pages/ResponsePage.aspx?id=v4j5cvGGr0GRqy180BHbR7en2Ais5pxKtso_Pz4b1_xUNTZBNzRKNlVQSFhZMU9aV09EVzYxWFdORCQlQCN0PWcu[signup form]. It can take several days for Microsoft to approve your access. When your access to {azure-openai} is approved, make sure you know which Azure subscription your {azure-openai} access is associated with.
{azure-openai} access currently requires an approval process initiated from within the {azure-full} portal. It can take several days for Microsoft to approve your access. When your access to {azure-openai} is approved, make sure you know which Azure subscription your {azure-openai} access is associated with.
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

Role-Based Access Control (RBAC) is a system security approach to restricting system access to authorized users who have defined roles and permissions.

{ols-long} RBAC is binary. By default, regular users of a cluster do not have access to the {ols-long} interface. Access must be granted by a user who can grant permissions. All {ols-long} users can see the {ols-long} button; however, only users with permissions can submit questions to the {ols-long} user interface.
{ols-long} RBAC is binary. By default, not all cluster users have access to the {ols-long} interface. Access must be granted by a user who can grant permissions. All users of an {ocp-short-name} cluster with {ols-long} installed can see the {ols-short} button; however, only users with permissions can submit questions to {ols-short}.

If you want to evaluate the RBAC features of {ols-long}, your cluster will need users other than the `kubeadmin` account. The `kubeadmin` account always has access to {ols-long}.
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@ spec:
$ oc create -f /path/to/config-cr.yaml
----
+
The Operator deploys OpenShift lightspeed using the information in YAML configuration file.
The Operator deploys {ols-long} using the information in YAML configuration file.
2 changes: 1 addition & 1 deletion modules/ols-installing-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

.Prerequisites

* You have deployed a cluster on {ocp-product-title} 4.15 or later. The cluster must be connected to the Internet and have telemetry enabled.
* You have deployed {ocp-product-title} 4.15 or later. The cluster must be connected to the Internet and have telemetry enabled.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* You have deployed {ocp-product-title} 4.15 or later. The cluster must be connected to the Internet and have telemetry enabled.
* You deployed {ocp-product-title} 4.15 or later.
* Your {ocp-product-title} cluster is connected to the internet.
* You enabled telemetry on your {ocp-product-title} cluster.

This one prerequisite can be divided into separate prereqs for readability.

* You are logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role.
Expand Down
2 changes: 1 addition & 1 deletion modules/ols-sample-dialogs-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
[id="ols-sample-dialogs-overview_{context}"]
= Sample conversation overview

The following examples are intended to serve as samples you can use to start a conversations {ols-long}. In some cases, the conversation includes an initial question and then one or more follow-up questions. Rephrasing questions or asking a more precise follow-up question can help increase the success of the reply.
The following examples are intended to serve as samples you can use to start a conversation with {ols-long}. In some cases, the conversation includes an initial question and then one or more follow-up questions. Rephrasing questions or asking a more precise follow-up question can help increase the success of the reply.

Some of the examples suggest specific workflows to follow in the user interface. Be sure to ask the follow-up questions without starting a new dialog. {ols-long} uses the entire conversation as context, so follow-up questions should help refine answers.
10 changes: 5 additions & 5 deletions modules/ols-transcript-collection-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@
[id="ols-transcript-collection-overview_{context}"]
= Transcript collection overview

{ols-long} temporarily logs and stores complete transcripts of conversations that users have with the virtual assistant. This includes:
Transcripts are sent to {red-hat} every two hours, by default. If you are using the filtering and redaction functionality, the filtered or redacted content is sent to {red-hat}. {red-hat} does not see the original non-redacted content, and the redaction takes place before any content is captured in logs.

{ols-long} temporarily logs and stores complete transcripts of conversations that users have with the virtual assistant. This includes the following information:

* Queries from the user.

* The complete message sent to the configured LLM provider, which includes system instructions, referenced documentation, and the user question.
* The complete message sent to the configured Large Language Model (LLM) provider, which includes system instructions, referenced documentation, and the user question.

* The complete response from the LLM provider.

Transcripts are associated with the cluster from which they originated, and {red-hat} can attribute specific clusters to specific customer accounts. Transcripts do not contain any information about which user submitted a question, and cannot be tied to any individual user.

Transcripts are sent to {red-hat} every two hours, by default. If you are using the filtering and redaction functionality, the filtered or redacted content is sent to {red-hat}. {red-hat} will not see the original non-redacted content, and the redaction takes place before any content is captured in logs.
Transcripts originate from the cluster and are associated with the cluster. {red-hat} can assign specific clusters to specific customer accounts. Transcripts do not contain any information about users.