Skip to content

Commit a31f8b6

Browse files
authored
Doc updates for doc issues found in v2.20 (#95)
* rhoai-25155 fix model deploy mode * doc-update for issue 94 * rhoai-26965 address peer review findings * Revert "rhoai-25155 fix model deploy mode" This reverts commit 3afaf61. * doc-updates-2.20 minor updates
1 parent 86887dc commit a31f8b6

File tree

6 files changed

+27
-14
lines changed

6 files changed

+27
-14
lines changed
-197 KB
Loading
11.7 KB
Loading
-146 KB
Loading

workshop/docs/modules/ROOT/pages/index.adoc

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@
66
[.text-center.strong]
77
== Introduction
88

9+
:rhoai-version: main (the latest)
10+
// for the downstream tutorial, change the value of rhoai-version to match the git-version value in the importing-files-into-jupyter.adoc file
11+
912
Welcome. In this {deliverable}, you learn how to incorporate data science and artificial intelligence and machine learning (AI/ML) into an OpenShift development workflow.
1013

1114
You use an example fraud detection model to complete the following tasks in https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-ai[{productname-long}] without the need to install anything on your computer:
@@ -27,14 +30,26 @@ Based on this data, the model outputs the likelihood of the transaction being fr
2730

2831
== Before you begin
2932

30-
You should have access to an OpenShift cluster where {productname-long} is installed.
31-
32-
If don't have access to a cluster that includes an instance of {productname-short}, see the https://developers.redhat.com/products/red-hat-openshift-ai/download[{productname-long} page on the {org-name} Developer website]. There, you can create an account and access the https://console.redhat.com/openshift/sandbox[*free {org-name} Developer Sandbox*] or you can learn how to install {productname-short} on *your own OpenShift cluster*.
33-
34-
33+
* You must have access to an OpenShift cluster where {productname-long} is installed.
34+
+
35+
If you do not have access to a cluster that includes an instance of {productname-short}, see the https://developers.redhat.com/products/red-hat-openshift-ai/download[{productname-long} page on the {org-name} Developer website]. There, you can create an account and access the https://console.redhat.com/openshift/sandbox[*free {org-name} Developer Sandbox*] or you can learn how to install {productname-short} on *your own OpenShift cluster*.
36+
+
3537
[IMPORTANT]
3638
====
3739
If your cluster uses self-signed certificates, before you begin the {deliverable}, your {productname-short} administrator must add self-signed certificates for {productname-short} as described in link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/latest/html/installing_and_uninstalling_openshift_ai_self-managed/working-with-certificates_certs[Working with certificates^] (Self-Managed) or link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/installing_and_uninstalling_openshift_ai_cloud_service/working-with-certificates_certs[Working with certificates^] (Cloud Service).
3840
====
3941

42+
* Make sure that the version of this tutorial matches the {productname-short} version on your cluster.
43+
+
44+
{productname-long} {rhoai-version} is the version described in this {deliverable}.
45+
+
46+
. To find the {productname-short} version for your cluster:
47+
.. Log in to the {productname-short} dashboard.
48+
.. In the top navigation bar, click the help icon (image:projects/rhoai-help-icon.png[Help icon]) and then select *About*.
49+
+
50+
The *About* page shows the installed version.
51+
. Check the link:https://access.redhat.com/articles/rhoai-supported-configs[{productname-long} Supported Configurations] page to verify that your installed version is a supported version.
52+
53+
. If this version of the tutorial does not match the installed version, access the matching version of the tutorial by navigating to the link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed[top-level {productname-long} documentation page] and selecting the matching version from the drop-down list.
54+
4055
If you're ready, xref:navigating-to-the-dashboard.adoc[start the {deliverable}].

workshop/docs/modules/ROOT/pages/navigating-to-the-dashboard.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
** *If you are using the {org-name} Developer Sandbox*:
99
+
10-
After you log in to the Sandbox, click *Getting Started* -> *Available services*, and then, in the {productname-long} card, click *Launch*.
10+
After you log in to the Sandbox, in the {productname-long} card, click *Launch*.
1111
+
1212
image::projects/sandbox-rhoai-tile.png[{productname-short} dashboard link]
1313

workshop/docs/modules/ROOT/pages/setting-up-your-data-science-project.adoc

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,21 +5,19 @@ To implement a data science workflow, you must create a data science project (as
55

66
.Prerequisites
77

8-
Before you begin, log in to *{productname-long}*.
8+
* You have logged in to *{productname-long}*.
99

1010
.Procedure
1111

12-
. On the navigation menu, select *Data science projects*. This page lists any existing projects that you have access to. From this page, you can select an existing project (if any) or create a new one.
12+
. On the navigation menu, select *Data science projects*. This page lists any existing projects that you have access to.
13+
14+
. *If you are using the {org-name} Developer Sandbox*, it provides a default data science project (for example, `myname-dev`). Select it and skip to the *Verification* section.
1315
+
14-
image::projects/launch-jupyter-link.png[Launch Jupyter link]
16+
*If you are using your own OpenShift cluster*, you can select an existing project (if any) or create a new one. Click *Create project*.
1517
+
1618
NOTE: It is possible to start a Jupyter notebook by clicking the *Launch standalone workbench* button, selecting a notebook image, and clicking *Start server*. However, it would be a one-off Jupyter notebook run in isolation.
1719

18-
. If you are using your own OpenShift cluster, click *Create project*.
19-
+
20-
NOTE: If you are using the {org-name} Developer Sandbox, you are provided with a default data science project (for example, `myname-dev`). Select it and skip over the next step to the *Verification* section.
21-
22-
. Enter a display name and description.
20+
. In the *Create project* modal, enter a display name and description.
2321
+
2422
image::projects/ds-project-new-form.png[New data science project form, 600]
2523

0 commit comments

Comments
 (0)