Skip to content

Commit 9dfd1dd

Browse files
committed
Minor changes for OpenShift AI Connector for RHDH 1.10
1 parent 42ffbe4 commit 9dfd1dd

7 files changed

Lines changed: 13 additions & 15 deletions

artifacts/attributes.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,7 @@
187187
:release-notes-book-title: {product} release notes
188188
:release-notes-category-link: {product-docs-link}/#Release Notes
189189
:rhbk-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_build_of_keycloak/{keycloak-version}
190-
:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single
190+
:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/3.4/html-single
191191
:rhoserverless-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/{rhoserverless-version-major}
192192
:scorecard-plugin-book-link: {product-docs-link}/html-single/evaluate_project_health_using_scorecards/index
193193
:scorecard-plugin-book-title: Evaluate project health using Scorecards

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/con-understand-how-ai-assets-map-to-the-rhdh-catalog.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[]
77

88
[role="_abstract"]
9-
The {openshift-ai-connector-name} ({openshift-ai-connector-name-short}) serves as a crucial link, enabling the discovery and accessibility of AI assets managed within the {rhoai-brand-name} offering directly within your {product-very-short} instance.
9+
The {openshift-ai-connector-name} ({openshift-ai-connector-name-short}) discovers AI assets managed within {rhoai-brand-name}. The connector automatically converts AI models and model servers into {backstage} entities to provide a unified view for developer teams.
1010

11-
For more information on model registry components, see {rhoai-docs-link}/enabling_the_model_registry_component/index#overview-of-model-registries_model-registry-config[Overview of model registries and model catalog].
11+
For more information on model registry components, see {rhoai-docs-link}/managing_model_registries/index#overview-of-model-registries_managing-model-registries[Overview of model registries and model catalog].

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/proc-set-up-with.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
= Set up {openshift-ai-connector-name} with {rhoai-brand-name}
55

66
[role="_abstract"]
7-
The installation of the {openshift-ai-connector-name} requires manual updates to {product-very-short}-related Kubernetes resources.
7+
To install the {openshift-ai-connector-name}, you must manually update your {product-very-short}-related Kubernetes resources.
88

99
include::{docdir}/artifacts/snip-developer-preview-rhoai.adoc[]
1010

@@ -22,7 +22,7 @@ If you upgraded to {rhoai-short} 2.25 from an earlier version, you must manually
2222
* For the rest of the features, version 2.20 or later suffices. Enabling model registry and its associated dashboard allows for a user experience that more directly allows for customizing AI Model metadata.
2323
For best overall experience, {rhoai-short} 2.25 is recommended.
2424

25-
For more details, see {rhoai-docs-link}/enabling_the_model_registry_component/index[Enabling the model registry component].
25+
For more details, see {rhoai-docs-link}/managing_model_registries/index#enabling-the-model-registry-component_managing-model-registries[Enabling the model registry component].
2626

2727
.Procedure
2828

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-enrich-ai-model-metadata-for-enhanced-rhdh-experience.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,19 @@ For more details, see {rhoai-docs-link}/working_with_model_registries/index#edit
2121

2222
|`TechDocs`
2323
|TechDocs
24-
|URL pointing to a Git repository that follows {product-very-short} TechDocs conventions for the Model Card. Use this setting only if the *Model Card to TechDocs* mapping is not active.
24+
|URL pointing to a Git repository that follows {product-very-short} TechDocs conventions for the Model Card. Use this setting only if the *Model Card to TechDocs* mapping is inactive.
2525

2626
|`Homepage URL`
2727
|Links
28-
|A URL considered the home page for the model.
28+
|The home page URL for the model.
2929

3030
|`Owner`
3131
|Owner
3232
|Overrides the default OpenShift user as the entity owner.
3333

3434
|`Lifecycle`
3535
|Lifecycle
36-
|Serves a means to express the lifecycle concept of {product-very-short}/{backstage}.
36+
|Expresses the lifecycle concept of {product-very-short}/{backstage}.
3737

3838
|`How to use`
3939
|Links

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-model-to-entity-mapping.adoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@
44
= Model-to-Entity mapping
55

66
[role="_abstract"]
7-
The {openshift-ai-connector-name-short} automatically converts AI/ML artifacts into {backstage} entities, providing a unified view of your available AI models to your developer teams.
8-
9-
The following table describes how {rhoai-short} artifacts map to {backstage} entity kinds.
7+
The following table maps {rhoai-short} components to {backstage} entity kinds.
108

119
|===
1210
|{rhoai-short} Artifact |{product-very-short}/{backstage} Entity Kind |{product-very-short}/{backstage} Entity Type |Purpose
@@ -29,7 +27,7 @@ The following table describes how {rhoai-short} artifacts map to {backstage} ent
2927
|Model Cards
3028
|TechDocs
3129
|N/A
32-
|Model cards from the {rhoai-short} model catalog are associated with the Component and Resource entities. See {rhoai-docs-link}/working_with_the_model_catalog/registering-a-model-from-the-model-catalog_working-model-catalog#registering-a-model-from-the-model-catalog_working-model-catalog[Registering a model from the model catalog].
30+
|Associates model cards from the {rhoai-short} model catalog with the Resource entities. See {rhoai-docs-link}/working_with_the_model_catalog/registering-a-model-from-the-model-catalog_working-model-catalog#registering-a-model-from-the-model-catalog_working-model-catalog[Registering a model from the model catalog].
3331
|===
3432

3533
Once the {openshift-ai-connector-name-short} is installed and connected with {rhoai-short}, the transfer of information commences automatically.

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-out-of-the-box-as-asset-details-synched-from.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Review the key data that the connector automatically propagates from {rhoai-shor
1111
** URL of the Kubernetes Service.
1212
** Authentication requirement status.
1313
* Model registry (Resource type `ai-model`):
14-
** Model description, artifact URIs, and author/owner information.
14+
** Model description, asset URIs, and author or owner information.
1515
* Model catalog:
1616
** Links to the Model Card (as {product-very-short} TechDocs).
1717
** Model license URL.

modules/integrate_accelerating-ai-development-with-openshift-ai-connector-for-rhdh/ref-troubleshooting-connector-functionality.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: REFERENCE
22

33
[id="troubleshooting-connector-functionality_{context}"]
4-
= Troubleshooting Connector functionality
4+
= Troubleshoot Connector functionality
55

66
[role="_abstract"]
7-
The connector system consists of the two dynamic plugins and the three {openshift-ai-connector-name-short} sidecar containers. Generally speaking, the logs collected must be provided to {company-name} Support for analysis.
7+
The connector system consists of the two dynamic plugins and the three {openshift-ai-connector-name-short} sidecar containers. You must gather logs from these components and provide them to {company-name} Support for diagnostic analysis.
88

99
The actual contents of the diagnostic data are not part of any product guaranteed specification, and can change at any time.
1010

0 commit comments

Comments
 (0)