OLS-1665: Update product coverage to make it clearer which products a… #92353
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@rh-tokeefe: This pull request references OLS-1665 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/XS
|
@rh-tokeefe: This pull request references OLS-1665 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-1665 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. |
|
🤖 Wed Apr 23 14:24:38 - Prow CI generated the docs preview: |
|
@rh-tokeefe: This pull request references OLS-1665 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
force-pushed
the
OLS-1665
branch
3 times, most recently
from
8132d42 to
e0a3f41
Compare
|
LGTM |
|
/label peer-review-needed |
openshift-ci
bot
added
the
peer-review-needed
|
@rh-tokeefe: This pull request references OLS-1665 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. |
|
/label peer-review-in-progress |
openshift-ci
bot
added
the
peer-review-in-progress
| @@ -5,7 +5,12 @@ | |||
| [id="ols-about-product-coverage_{context}"] | |||
| = About product coverage | |||
|
|
|||
| {ols-official} generates answers to questions based on the content in the official {ocp-product-title} product documentation. The documentation for the following products is not part of the {ocp-short-name} product documentation; therefore, {ols-short} has limited context for generating answers about these products: | |||
| {ols-official} generates answers to questions based on the content in the {ocp-product-title} product documentation. | |||
There was a problem hiding this comment.
https://www.ibm.com/docs/en/ibm-style?topic=grammar-anthropomorphism
Sentence can be rewritten as
{ols-official} provides information in response to user queries based on the content from the {ocp-product-title} product documentation.
There was a problem hiding this comment.
s/ {ols-official} generates responses based on the content from the {ocp-product-title} product documentation.
| [id="product-exceptions_{context}"] | ||
| == Product exceptions | ||
|
|
||
| The {ocp-product-title} product documentation does not include information about all products in the {red-hat} portfolio. As a result, the {ols-official} Service relies on the large language model (LLM) you provide to generate answers for the following products or components: |
There was a problem hiding this comment.
Anthropomorphism. same comment as above.
sentence can be rewritten as
"As a result, the {ols-official} service uses the large language model (LLM) you provide to produce output for the following products or components:"
|
@aravipra your comments LGTM and I have nothing else to add to this review! |
|
/remove-label peer-review-in-progress |
openshift-ci
bot
removed
the
peer-review-in-progress
|
/remove-label peer-review-needed |
openshift-ci
bot
removed
the
peer-review-needed
|
/label peer-review-done |
openshift-ci
bot
added
the
peer-review-done
|
/label merge-review-needed |
openshift-ci
bot
added
the
merge-review-needed
ShaunaDiaz
removed
the
merge-review-needed
There was a problem hiding this comment.
I also noticed that you say this is DevPreview in your PR, but the docs say Technology Preview here, https://92353--ocpdocs-pr.netlify.app/openshift-lightspeed/latest/about/ols-about-openshift-lightspeed.html#ols-openshift-requirements. You'll want to clarify this as the support scope between the two (e.g., lack thereof for Dev Preview) is very different.
| [id="product-exceptions_{context}"] | ||
| == Product exceptions | ||
|
|
||
| The {ocp-product-title} product documentation does not include information about all products in the {red-hat} portfolio. As a result, the {ols-official} Service uses the large language model (LLM) you provide to produce output for the following products or components: |
There was a problem hiding this comment.
| The {ocp-product-title} product documentation does not include information about all products in the {red-hat} portfolio. As a result, the {ols-official} Service uses the large language model (LLM) you provide to produce output for the following products or components: | |
| The {ocp-product-title} product documentation does not include information about all products in the {red-hat} portfolio. As a result, the {ols-official} service uses the large language model (LLM) you provide to produce output for the following products or components: |
"Service" is not part of the component name, so this should be lowercase, see https://docs.google.com/spreadsheets/d/1DLS_lS3VKidgZIvcLmLp9BoiqptkvqHWfe1D5FD2kfk/edit?gid=1375785039#gid=1375785039.
|
@rh-tokeefe: This pull request references OLS-1665 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. |
|
@ShaunaDiaz my mistake, I updated the PR description so it says technology preview. |
|
@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. |
|
/cherrypick lightspeed-docs-1.0tp1 |
|
@ShaunaDiaz: new pull request created: #92601 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 kubernetes-sigs/prow repository. |
Affects:
lightspeed-main
lightspeed-docs-1.0tp1
This PR is part of the standalone doc set for the Lightspeed project. Kathryn is aware that this content applies for a product that is part of a Technology Preview release. The project is seeking feedback from early adopters.
PR must be CP'd back to the lightspeed-docs-1.0tp1 branch.
Version(s): TP
Issue: https://issues.redhat.com/browse/OLS-1665
Link to docs preview:
https://92353--ocpdocs-pr.netlify.app/openshift-lightspeed/latest/about/ols-about-openshift-lightspeed.html#ols-about-product-coverage_ols-about-openshift-lightspeed
QE review:
Additional information: