[release-1.7] RHDHPAI-808: Developer Lightspeed content RHDH (#1313)

* Developer Lightspeed content RHDH

* updated product short name

* Incorporated Karthik's comments

* Incorporated Judy's comments

* Incorporated Karthik's review comments

* Rectify the bullets

* Some self review changes

* Removed cross references

* Incorporated Jordan's comments

* Maysun's comments

* Incorporated Judy's and Ben's comments

---------

Co-authored-by: Priyanka Abel <[email protected]>

Author: openshift-cherrypick-robot

artifacts/attributes.adoc

@@ -87,7 +87,12 @@
 :gcp-brand-name: Google Cloud Platform
 :gcp-short: GCP
 
-
+//Developer Lightspeed
+:ls-brand-name: Red Hat Developer Lightspeed for {product}
+:ls-short: Developer Lightspeed for {product-very-short}
+:rcs-name: Road-Core Service
+:rcs-short: RCS
+:rhoai-brand-name: Red Hat OpenShift AI
 // Links
 
 

artifacts/snip-developer-preview.adoc

@@ -1,6 +1,6 @@
 [IMPORTANT]
 ====
-This section describes Developer Preview features in the Adoption Insights plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
+This section describes Developer Preview features in the {ls-brand-name} plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
 
 For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
 ====

assemblies/assembly-appendix-about-user-data-security.adoc

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: appendix-about-user-data-security
+[id="{context}"]
+= Appendix About user data security
+
+include::modules/developer-lightspeed/con-about-data-use.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-about-feedback-collection.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-about-bring-your-own-model.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-your-responsiblity.adoc[leveloffset=+1]

assemblies/assembly-appendix-llm-requirements.adoc

@@ -0,0 +1,13 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: appendix-llm-requirements
+[id="{context}"]
+= Appendix: LLM requirements
+
+
+include::modules/developer-lightspeed/con-llm-requirements.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-openai.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-ollama.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-vllm.adoc[leveloffset=+1]

assemblies/assembly-customizing-developer-lightspeed.adoc

@@ -0,0 +1,14 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: customizing-developer-lightspeed
+[id="{context}"]
+= Customizing {ls-short}
+
+You can customize {ls-short} functionalities, such as, question validation, gathering feedback, and storing chat history in PostgreSQL.
+
+include::modules/developer-lightspeed/proc-using-question-validation.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/proc-gathering-feedback.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/proc-updating-the-system-prompt.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/proc-customizing-the-chat-history-storage.adoc[leveloffset=+1]

assemblies/assembly-developer-lightspeed.adoc

@@ -0,0 +1,22 @@
+:_mod-docs-content-type: ASSEMBLY
+:context: developer-lightspeed
+[id="{context}"]
+= Interacting with {ls-brand-name}
+
+include::modules/developer-lightspeed/con-about-developer-lightspeed.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-supported-architecture.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/con-about-road-core-service.adoc[leveloffset=+2]
+
+include::modules/developer-lightspeed/con-rag-embeddings.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/proc-installing-and-configuring-lightspeed.adoc[leveloffset=+1]
+
+include::assembly-customizing-developer-lightspeed.adoc[leveloffset=+1]
+
+include::assembly-using-developer-lightspeed.adoc[leveloffset=+1]
+
+include::assembly-appendix-llm-requirements.adoc[leveloffset=+1]
+
+include::assembly-appendix-about-user-data-security.adoc[leveloffset=+1]

assemblies/assembly-using-developer-lightspeed.adoc

@@ -0,0 +1,49 @@
+ifdef::context[:parent-context-of-about-rhdh: {context}]
+
+:_mod-docs-content-type: ASSEMBLY
+
+ifndef::context[]
+[id="using-developer-lightspeed"]
+endif::[]
+ifdef::context[]
+[id="using-developer-lightspeed_{context}"]
+endif::[]
+= Using {ls-short}
+
+:context: Using-developer-lightspeed
+
+{ls-brand-name} is designed to support you when performing various tasks during your development workflow.
+
+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…”
+
+* “Draft the end-user documentation describing how to use the following cli command…”
+
+include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-start-a-chat-for-the-first-time.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-using-developer-lightspeed-to-view-chat-history.adoc[leveloffset=+1]
+
+include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-delete-a-chat.adoc[leveloffset=+1]

images/rhdh-plugins-reference/developer-lightspeed.png

@@ -0,0 +1,12 @@
+:_mod-docs-content-type: CONCEPT
+[id="con-about-bring-your-own-model_{context}"]
+= About Bring Your Own Model
+
+{ls-short} does not provide its own inference services, but uses a _Bring Your Own Model_ approach. This means that you can configure the {rcs-name} to talk to the inference server or service of your choice. This also means that you are responsible for ensuring that the configured service meets your particular company policies and legal requirements, including any applicable terms with the third-party model provider.
+//Add the cross reference to "Bring your own model"
+The only technical requirements for inference services are:
+
+* The service must conform to the link:https://github.com/openai/openai-openapi/tree/manual_spec[OpenAI API specification].
+* The service must be configured correctly following the installation and configuration instructions.
+// Add the cross-reference to "Installation and configuraiton" after the docs are published
+There are many commercial and open source inference services that support the OpenAI API specification for chat completions. The cost, performance, and security of these services can differ and it is up to you to choose, through evaluation and testing, the inference service that best meets your company's needs.

modules/developer-lightspeed/con-about-bring-your-own-model.adoc

@@ -0,0 +1,7 @@
+:_mod-docs-content-type: CONCEPT
+[id="con-about-data-use_{context}"]
+= About data use
+
+{ls-short} is a virtual assistant you interact with using natural language. Using the {ls-short} interface, you send chat messages that {ls-short} transforms and sends to the large language model (LLM) provider you have configured for your environment. These messages could potentially contain information provided by your users about themselves, your cluster, cluster resources, or other aspects of your business or working environment.
+
+{ls-short} has limited capabilities to filter or redact the information you provide to the LLM. Do not enter information into {ls-short} that you do not want to send to the LLM provider. To remind end users not to share private or confidential information, {ls-short} begins each new chat with an 'Important' message asking them not to “include personal or sensitive information” in their chat messages.