Fixing broken links with downstream link checker (#1035)

* Fixing broken links with downstream link checker

* typo

* typo2

Author: aduquett

assemblies/creating-and-importing-jupyter-notebooks.adoc

@@ -18,7 +18,7 @@ include::modules/emptying-trash-directory.adoc[leveloffset=+2]
 
 [role='_additional-resources']
 == Additional resources
-* link:{odhdocshome}/working-in-your-data-science-ide/#collaborating-on-jupyter-notebooks-by-using-git_{context}[Collaborating on Jupyter notebooks by using Git]
+* link:{odhdocshome}/working-in-your-data-science-ide/#collaborating-on-jupyter-notebooks-by-using-git_ide[Collaborating on Jupyter notebooks by using Git]
 
 
 ifdef::parent-context[:context: {parent-context}]

assemblies/installing-odh-v1.adoc

@@ -23,7 +23,7 @@ include::modules/creating-a-new-project-for-your-odh-instance.adoc[leveloffset=+
 
 include::modules/adding-an-odh-instance.adoc[leveloffset=+1]
 
-include::modules/accessing-the-odh-dashboard.adoc[leveloffset=+1]
+include::modules/accessing-the-dashboard.adoc[leveloffset=+1]
 
 ifdef::parent-context[:context: {parent-context}]
 ifndef::parent-context[:!context:]

installing-open-data-hub.adoc

@@ -22,7 +22,7 @@ include::modules/configuring-pipelines-with-your-own-argo-workflows-instance.ado
 
 include::modules/installing-the-distributed-workloads-components.adoc[leveloffset=+1]
 
-include::modules/accessing-the-odh-dashboard.adoc[leveloffset=+1]
+include::modules/accessing-the-dashboard.adoc[leveloffset=+1]
 
 include::assemblies/working-with-certificates.adoc[leveloffset=+1]
 

modules/about-gpu-time-slicing.adoc

@@ -16,4 +16,4 @@ Consider the following points when using GPU time slicing:
 [role="_additional-resources"]
 .Additional resources
 * link:https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/gpu-sharing.html[NVIDIA GPU Sharing Documentation]
-* link:https://github.com/stratus-ss/openshift-ai/blob/main/docs/rendered/OpenShift_AI_CLI.md#nvidia---configuring-time-slicing[OpenShift AI CLI - Configuring Time Slicing]
+//* link:https://github.com/stratus-ss/openshift-ai/blob/main/docs/rendered/OpenShift_AI_CLI.md#nvidia---configuring-time-slicing[OpenShift AI CLI - Configuring Time Slicing]

modules/accessing-the-dashboard.adoc

@@ -0,0 +1,46 @@
+:_module-type: PROCEDURE
+
+[id='accessing-the-dashboard_{context}']
+= Accessing the dashboard
+
+[role='_abstract']
+After you have installed {productname-short} and added users, you can access the URL for your {productname-short} console and share the URL with the users to let them log in and work on their models. 
+
+ifndef::upstream[]
+.Prerequisites
+* You have installed {productname-short} on your {openshift-platform} cluster.
+* You have added at least one user to the user group for {productname-short}.
+
+.Procedure
+. Log in to {openshift-platform} web console.
+. Click the application launcher (image:images/osd-app-launcher.png[The application launcher]).
+. Right-click *{productname-long}* and copy the URL for your {productname-short} instance.
+. Provide this instance URL to your data scientists to let them log in to {productname-short}.
+
+.Verification
+* Confirm that you and your users can log in to {productname-short} by using the instance URL.
+
+*Note:* In the {productname-long} dashboard, users can view the list of the installed {productname-short} components, their corresponding source (upstream) components, and the versions of the installed components, as described in link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/logging-in_get-started#viewing-installed-components_get-started[Viewing installed components].
+
+[role="_additional-resources"]
+.Additional resources
+
+* link:{rhoaidocshome}{default-format-url}/getting_started_with_{url-productname-long}/logging-in_get-started[Logging in to {productname-short}]
+* link:{rhoaidocshome}{default-format-url}/managing_openshift_ai/managing-users-and-groups#adding-users-to-user-groups_managing-rhoai[Adding users to {productname-short} user groups]
+endif::[]
+
+ifdef::upstream[]
+.Prerequisites
+* You have installed the {productname-short} Operator.
+
+.Procedure
+. Log in to {openshift-platform} web console.
+. Click the application launcher (image:images/osd-app-launcher.png[The application launcher]).
+. Right-click *{productname-long}* and copy the URL for your {productname-short} instance.
+. Give this URL to your users to let them log in to {productname-short} dashboard.
+
+.Verification
+* Confirm that you and your users can log in to the {productname-short} dashboard by using the URL.
+
+*Note:* In the {productname-long} dashboard, users can view the list of the installed {productname-short} components, their corresponding source (upstream) components, and the versions of the installed components, as described in link:{odhdocshome}/getting-started-with-open-data-hub/#viewing-installed-components_get-started[Viewing installed {productname-short} components].
+endif::[]

modules/accessing-the-odh-dashboard.adoc

@@ -129,7 +129,7 @@ The *Serving runtimes* page opens and shows the updated list of runtimes that ar
 [role='_additional-resources']
 .Additional resources
 ifndef::upstream[]
-* To learn how to configure a model server that uses a model-serving runtime that you have added, see link:{rhoaidocshome}{default-format-url}/deploying_models/deploying-models_rhoai-user#adding-a-model-server-for-the-multi-model-serving-platform_rhoai-user[Adding a model server to your data science project].
+* To learn how to configure a model server that uses a model-serving runtime that you have added, see link:{rhoaidocshome}{default-format-url}/deploying_models/deploying_models_on_the_multi_model_serving_platform#adding-a-model-server-for-the-multi-model-serving-platform_rhoai-user[Adding a model server to your data science project].
 endif::[]
 ifdef::upstream[]
 * To learn how to configure a model server that uses a model-serving runtime that you have added, see link:{odhdocshome}/deploying-models/#adding-a-model-server-for-the-multi-model-serving-platform_odh-user[Adding a model server to your data science project].

modules/adding-a-tested-and-verified-runtime-for-the-multi-model-serving-platform.adoc

@@ -12,18 +12,18 @@ By adding an Open Data Hub instance to your project, you can access the URL for
 
 .Procedure
 . In the OpenShift web console, select *Operators* -> *Installed Operators*. 
-. On the *Installed Operators* page, click the *Project* list and select the `odh` project. The page filters to only display installed operators  in the `odh` project.
+. On the *Installed Operators* page, click the *Project* list and select the `pass:attributes[{dbd-config-default-namespace}]` project.
 . Find and click the *Open Data Hub Operator* to display the details for the currently installed version.
 . On the *KfDef* tile, click *Create instance*. A `KfDef` object is a specification designed to control provisioning and management of a Kubeflow deployment. A default `KfDef` object is created when you install Open Data Hub Operator. This default configuration deploys the required Open Data Hub core components. For more information, see link:https://opendatahub.io/docs/tiered-components[Tiered Components].
 . On the *Create KfDef* page, leave *opendatahub* as the name. Click *Create* to create an Open Data Hub kfdef object named *opendatahub* and begin the deployment of the components.
 
 .Verification
 . Select *Operators* -> *Installed Operators*.
-. On the *Installed Operators* page, click the *Project* list and select the `odh` project.
+. On the *Installed Operators* page, click the *Project* list and select the `pass:attributes[{dbd-config-default-namespace}]` project.
 . Find and click *Open Data Hub Operator*.
 . Click the *Kf Def* tab and confirm that *opendatahub* is displayed.
 . Select *Home* -> *Projects*.
-. On the *Projects* page, find and select the *odh* project.
+. On the *Projects* page, find and select the `pass:attributes[{dbd-config-default-namespace}]` project.
 . On the *Project details* page, click the *Workloads* tab and confirm that the Open Data Hub core components are running. For a description of the components, see link:https://opendatahub.io/docs/tiered-components[Tiered Components].
 
 

modules/adding-an-odh-instance.adoc

@@ -23,7 +23,6 @@ ifdef::cloud-service[]
 endif::[]
 * You have created a data science project. In the example in this procedure, the project is named `my-data-science-project`.
 
-//will probably need to fix these links
 ifdef::upstream[]
 * You know the URL for the workbench image that you want to use in the workbench. The example in this procedure uses the custom image that you created in link:{odhdocshome}/api-workbench/#api-custom-image-creating_api-workbench[Creating a custom image by using the `ImageStream` CRD]. 
 endif::[]
@@ -54,7 +53,7 @@ metadata:
   annotations:
     notebooks.opendatahub.io/inject-oauth: 'true' # <1>
     opendatahub.io/image-display-name: My Custom Notebook # <2>
-    notebooks.opendatahub.io/oauth-logout-url: 'https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com/projects/my-data-science-project?notebookLogout=my-workbench'
+    notebooks.opendatahub.io/oauth-logout-url: 'https://<dashboard_URL>/projects/my-data-science-project?notebookLogout=my-workbench'
     opendatahub.io/accelerator-name: ''
     openshift.io/description: '' # <3>
     openshift.io/display-name: My Workbench # <4>
@@ -108,7 +107,7 @@ spec:
                 --ServerApp.password=''
                 --ServerApp.base_url=/notebook/my-data-science-project/my-workbench
                 --ServerApp.quit_button=False
-                --ServerApp.tornado_settings={"user":"kube-3aadmin","hub_host":"https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com", "hub_prefix":"/projects/my-data-science-project"}
+                --ServerApp.tornado_settings={"user":"<user>","hub_host":"<dashboard_URL>", "hub_prefix":"/projects/my-data-science-project"}
             - name: JUPYTER_IMAGE
               value: 'image-registry.openshift-image-registry.svc:5000/redhat-ods-applications/my-custom-notebook:1.0'
             - name: PIP_CERT
@@ -195,7 +194,7 @@ spec:
             - '--email-domain=*'
             - '--skip-provider-button'
             - '--openshift-sar={"verb":"get","resource":"notebooks","resourceAPIGroup":"kubeflow.org","resourceName":"my-workbench","namespace":"$(NAMESPACE)"}'
-            - '--logout-url=https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com/projects/my-data-science-project?notebookLogout=my-workbench'
+            - '--logout-url=<dashboard_URL>/projects/my-data-science-project?notebookLogout=my-workbench'
       enableServiceLinks: false
       serviceAccountName: my-workbench
       volumes:
@@ -246,7 +245,7 @@ kind: Notebook
 metadata:
   annotations:
     ...
-    notebooks.opendatahub.io/oauth-logout-url: 'https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com/projects/my-data-science-project?notebookLogout=my-workbench' # <1>
+    notebooks.opendatahub.io/oauth-logout-url: '<dashboard_URL>/projects/my-data-science-project?notebookLogout=my-workbench' # <1>
     ...
 ----
 
@@ -269,7 +268,7 @@ spec:
       - resources:
       ...
        args:
-       - '--logout-url=https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com/projects/my-data-science-project?notebookLogout=my-workbench' # <1>
+       - '--logout-url=<dashboard_URL>/projects/my-data-science-project?notebookLogout=my-workbench' # <1>
        ...
 ----
 
@@ -358,7 +357,7 @@ Annotations:  notebooks.kubeflow.org/last-activity: 2024-07-30T20:27:25Z
               notebooks.opendatahub.io/last-image-selection: my-custom-notebook:1.0
               notebooks.opendatahub.io/last-size-selection: Small
               notebooks.opendatahub.io/oauth-logout-url:
-                https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com/projects/my-data-science-project?notebookLogout=my-workbench
+                <dashboard_URL>/projects/my-data-science-project?notebookLogout=my-workbench
               opendatahub.io/accelerator-name:
               opendatahub.io/image-display-name: My Custom Notebook
               opendatahub.io/username: kube:admin
@@ -383,7 +382,7 @@ Spec:
 --ServerApp.password=''
 --ServerApp.base_url=/notebook/my-data-science-project/my-workbench
 --ServerApp.quit_button=False
---ServerApp.tornado_settings={"user":"kube-3aadmin","hub_host":"https://rhods-dashboard-redhat-ods-applications.apps.my-cluster.com", "hub_prefix":"/projects/my-data-science-project"}
+--ServerApp.tornado_settings={"user":"kube-3aadmin","hub_host":"<dashboard_URL>", "hub_prefix":"/projects/my-data-science-project"}
           Name:             JUPYTER_IMAGE
           Value:            image-registry.openshift-image-registry.svc:5000/redhat-ods-applications/my-custom-notebook:1.0
           Name:             PIP_CERT

modules/api-workbench-creating.adoc

@@ -19,8 +19,8 @@ ifdef::cloud-service[]
 ** link:https://docs.redhat.com/en/documentation/openshift_dedicated/{osd-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^] for OpenShift Dedicated  
 ** link:https://docs.redhat.com/en/documentation/red_hat_openshift_service_on_aws_classic_architecture/{rosa-classic-latest-version}/html/cli_tools/openshift-cli-oc#installing-openshift-cli[Installing the OpenShift CLI^] for {rosa-classic-productname}
 endif::[]
-* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/index#preparing-to-configure-the-monitoring-stack-uwm[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
-* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/index#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
+* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/configuring-core-platform-monitoring#preparing-to-configure-the-monitoring-stack[creating a config map] for monitoring a user-defined workflow. You will perform similar steps in this procedure.
+* You are familiar with link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/configuring-user-workload-monitoring#enabling-monitoring-for-user-defined-projects-uwm_preparing-to-configure-the-monitoring-stack-uwm[enabling monitoring] for user-defined projects in OpenShift. You will perform similar steps in this procedure.
 * You have link:https://docs.redhat.com/en/documentation/openshift_container_platform/{ocp-latest-version}/html/monitoring/configuring-user-workload-monitoring#granting-users-permission-to-monitor-user-defined-projects_preparing-to-configure-the-monitoring-stack-uwm[assigned] the `monitoring-rules-view` role to users that will monitor metrics.
 
 .Procedure