diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 980185d27714..9d79d62c57fb 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -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 diff --git a/contributing_to_docs/term_glossary.adoc b/contributing_to_docs/term_glossary.adoc index 94538e00962e..f42a90200ceb 100644 --- a/contributing_to_docs/term_glossary.adoc +++ b/contributing_to_docs/term_glossary.adoc @@ -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 @@ -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 diff --git a/modules/ols-about-azure-openai.adoc b/modules/ols-about-azure-openai.adoc index 43ab118e01a2..7d39ab9f0c6c 100644 --- a/modules/ols-about-azure-openai.adoc +++ b/modules/ols-about-azure-openai.adoc @@ -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. diff --git a/modules/ols-about-lightspeed-and-role-based-access-control.adoc b/modules/ols-about-lightspeed-and-role-based-access-control.adoc index d1dd053428a5..aa491933eae4 100644 --- a/modules/ols-about-lightspeed-and-role-based-access-control.adoc +++ b/modules/ols-about-lightspeed-and-role-based-access-control.adoc @@ -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}. \ No newline at end of file diff --git a/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc b/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc index 8e10984f4938..29a8e69c3bb6 100644 --- a/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc +++ b/modules/ols-creating-lightspeed-custom-resource-file-using-cli.adoc @@ -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. diff --git a/modules/ols-installing-operator.adoc b/modules/ols-installing-operator.adoc index caf044e65d37..1a8ae0b84fe8 100644 --- a/modules/ols-installing-operator.adoc +++ b/modules/ols-installing-operator.adoc @@ -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. * You are logged in to the {ocp-product-title} web console as a user with the `cluster-admin` role. diff --git a/modules/ols-sample-dialogs-overview.adoc b/modules/ols-sample-dialogs-overview.adoc index 27eff236dfad..14cd173d8858 100644 --- a/modules/ols-sample-dialogs-overview.adoc +++ b/modules/ols-sample-dialogs-overview.adoc @@ -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. diff --git a/modules/ols-transcript-collection-overview.adoc b/modules/ols-transcript-collection-overview.adoc index 6394a9c95cef..ea28c1534e08 100644 --- a/modules/ols-transcript-collection-overview.adoc +++ b/modules/ols-transcript-collection-overview.adoc @@ -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.