Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RHOAIENG-4167: adding dashboard options as prereqs #238

Merged
merged 3 commits into from
Mar 28, 2024

Conversation

syaseen-rh
Copy link
Contributor

@syaseen-rh syaseen-rh commented Mar 25, 2024

Description

Adding a few dashboard configuration options as prerequisites within the serving models section, where relevant.
https://issues.redhat.com/browse/RHOAIENG-4167

How Has This Been Tested?

Local build

Preview

Screenshot 2024-03-25 at 4 09 17 PM Screenshot 2024-03-25 at 4 11 00 PM Screenshot 2024-03-25 at 4 12 05 PM

@@ -14,6 +14,15 @@ endif::[]
ifdef::upstream[]
* If you are using specialized {productname-short} groups, you are part of the admin group (for example, {odh-admin-group}) in OpenShift.
endif::[]
* Your cluster administrator has set the value of the `disableModelMesh` dashboard configuration to `false` in the `OdhDashboardConfig` custom resource (CR).
Copy link
Contributor

Choose a reason for hiding this comment

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

This is a nice update. Having said that, we wouldn't typically show configuration code in a prerequisite bullet in this way. I think we should mainly rely on the link to the main dashboard configuration documentation.

How about something a little more general, like this?

* A cluster administrator has _not_ edited the {productname-short} dashboard configuration to disable the ModelMesh component. For more information, see link:{rhoaidocshome}/html/managing_resources/customizing-the-dashboard#ref-dashboard-configuration-options_dashboard[Dashboard configuration options].

Copy link
Contributor Author

@syaseen-rh syaseen-rh Mar 27, 2024

Choose a reason for hiding this comment

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

Addressed in the latest commit.

@@ -14,6 +14,7 @@ endif::[]
ifdef::upstream[]
* If you are using specialized {productname-short} groups, you are part of the admin group (for example, {odh-admin-group}) in OpenShift.
endif::[]
* Your cluster administrator has _not_ edited the {productname-short} dashboard configuration to disable the ability to select ModelMesh as a serving platform. For more information, see link:{rhoaidocshome}/html/managing_resources/customizing-the-dashboard#ref-dashboard-configuration-options_dashboard[Dashboard configuration options].
Copy link
Contributor

Choose a reason for hiding this comment

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

We shouldn't refer to ModelMesh as a serving platform. ModelMesh is the component that underpins the multi-model serving platform.

In that case, we should say "...to disable the ability to select the multi-model serving platform, which uses the ModelMesh component."

I know this description came from here, so we need to get it updated there too. In addition, that description should not use "Serving Platform", capitalized.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Addressed in latest commit.

@@ -15,7 +15,9 @@ ifdef::upstream[]
* If you are using specialized {productname-short} groups, you are part of the admin group (for example, {odh-admin-group}) in OpenShift.
endif::[]
* You have installed KServe.
* Your cluster administrator has _not_ edited the {productname-short} dashboard configuration to disable the ability to select KServe as a serving platform. For more information, see link:{rhoaidocshome}/html/managing_resources/customizing-the-dashboard#ref-dashboard-configuration-options_dashboard[Dashboard configuration options].
Copy link
Contributor

Choose a reason for hiding this comment

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

Ditto

@syaseen-rh syaseen-rh changed the title adding dashboard options as prereqs RHOAIENG-4167: adding dashboard options as prereqs Mar 28, 2024
@syaseen-rh syaseen-rh merged commit 94cc8ce into opendatahub-io:main Mar 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants