OLS-1953: Create OLS 1.0.3 release notes #96545
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@rh-tokeefe: This pull request references OLS-1953 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/S
|
@rh-tokeefe: This pull request references OLS-1953 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
@rh-tokeefe: This pull request references OLS-1953 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
🤖 Tue Jul 29 14:24:18 - Prow CI generated the docs preview: |
|
@rh-tokeefe: This pull request references OLS-1953 which is a valid jira issue. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
size/M
modules/ols-1-0-3-release-notes.adoc
Outdated
| indexID: vector_db_index | ||
| ---- | ||
| + | ||
| Previously, you had to manually define the parameter values. |
There was a problem hiding this comment.
This emphasizes the wrong side of the equation. The key to this change is that from now on it is only necessary to specify the BYOK image and not these two parameters. Users don't need know they exist and what values they hold. All they need to know is the name of the BYOK image.
There was a problem hiding this comment.
Thanks for the comment @syedriko. I pushed a change.
I know you mentioned the customer doesn't really need to know about the two parameters, but I feel like we have to mention the defaults for them or not mention them at all.
Instead of what was pushed to the PR do think something like the following would be better?
With this update, when you specify BYO Knowledge information sources in OLSConfig.spec.ols.rag specification file specify the URL path for the image file.
+
.Example configuration
[source,yaml,subs="attributes,verbatim"]
spec:
ols:
rag:
- image: quay.io//my-byok-image:latest
|
@rh-tokeefe: all tests passed! Full PR test history. Your PR dashboard. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
Affects:
lightspeed-main
lightspeed-docs-1.0
PR must be CP'd back to the lightspeed-docs-1.0 branch.
Version(s): 1.0
Issue: https://issues.redhat.com/browse/OLS-1953
Link to docs preview:
https://96545--ocpdocs-pr.netlify.app/openshift-lightspeed/latest/release_notes/ols-release-notes.html#ols-1-0-3-release-notes_ols-release-notes
QE review:
Additional information: