Skip to content

Commit

Permalink
Update doc links to docs.redhat (#3282)
Browse files Browse the repository at this point in the history
* Update doc links to docs.redhat

* Update docs.openshift links

* update links

* link update

* link fix

* merge conflict

* remove space

* line

* line
  • Loading branch information
aduquett authored Oct 16, 2024
1 parent cdc5b4c commit 4d29174
Show file tree
Hide file tree
Showing 14 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion docs/dev-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ ODH requires the following to run:
- [NodeJS and NPM](https://nodejs.org/)
- Node recommended version -> `18.18.2`
- NPM recommended version -> `9.8.1`
- [OpenShift CLI](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html)
- [OpenShift CLI](https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/cli_tools/openshift-cli-oc)
- [kustomize](https://github.com/kubernetes-sigs/kustomize) (if you need to do deployment)

### Additional tooling
Expand Down
4 changes: 2 additions & 2 deletions frontend/src/__mocks__/mockComponents.ts

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions frontend/src/__mocks__/mockDocs.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ export const mockDocs = (): OdhDocument[] => [
displayName: 'How to install Python packages on your notebook server',
durationMinutes: 15,
type: 'how-to',
url: 'https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/working_on_data_science_projects/index#installing-python-packages-on-your-notebook-server_nb-server/index',
url: 'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_connected_applications/using_the_jupyter_application#installing-python-packages-on-your-notebook-server_connected-apps',
},
},
{
Expand All @@ -32,11 +32,11 @@ export const mockDocs = (): OdhDocument[] => [
},
spec: {
appName: 'jupyter',
description: 'Update the settings or the notebook image on your notebook server.',
displayName: 'How to update notebook server settings',
description: 'Manage the settings or the notebook image on your notebook server.',
displayName: 'How to manage notebook server settings',
durationMinutes: 15,
type: 'how-to',
url: 'https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/how_to_update_notebook_server_settings/index',
url: 'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_resources/managing-notebook-servers_notebook-mgmt',
},
},
{
Expand All @@ -51,11 +51,11 @@ export const mockDocs = (): OdhDocument[] => [
},
spec: {
appName: 'jupyter',
description: 'Connect to data in S3 Storage using environment variables.',
displayName: 'How to use data from Amazon S3 buckets',
description: 'Connect to data in S3 Storage.',
displayName: 'How to use data from an S3-compatible object store',
durationMinutes: 15,
type: 'how-to',
url: 'https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/how_to_use_data_from_amazon_s3_buckets/index',
url: 'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_data_in_an_s3-compatible_object_store/index',
},
},
{
Expand All @@ -74,7 +74,7 @@ export const mockDocs = (): OdhDocument[] => [
displayName: 'How to view installed packages on your notebook server',
durationMinutes: 15,
type: 'how-to',
url: 'https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/how_to_view_installed_packages_on_your_notebook_server/index',
url: 'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_connected_applications/using_the_jupyter_application#viewing-python-packages-installed-on-your-notebook-server_connected-apps',
},
},
];
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ import { useIsAreaAvailable, SupportedArea } from '~/concepts/areas';
import { ODH_PRODUCT_NAME } from '~/utilities/const';

const INVALID_ARGO_DEPLOYMENT_SELF_DOCUMENTATION_URL =
'https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_self-managed/2.9/html/release_notes/new-features-and-enhancements_relnotes';
'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2-latest/html/working_with_data_science_pipelines/enabling-data-science-pipelines-2_ds-pipelines';

const INVALID_ARGO_DEPLOYMENT_CLOUD_DOCUMENTATION_URL =
'https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_cloud_service/1/html/release_notes/new-features-and-enhancements_relnotes';
'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_data_science_pipelines/enabling-data-science-pipelines-2_ds-pipelines';

export const InvalidArgoDeploymentAlert: React.FC = () => {
const [invalidArgoDeploymentAlertDismissed, setInvalidArgoDeploymentAlertDismissed] =
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/pages/clusterSettings/TelemetrySettings.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ const TelemetrySettings: React.FC<TelemetrySettingsProps> = ({
For more information see the{' '}
<Text
component={TextVariants.a}
href="https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/usage-data-collection#usage-data-collection-notice-for-openshift-data-science"
href="https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_resources/usage-data-collection"
target="_blank"
>
documentation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ const NotebookAdminControl: React.FC = () => {
Create, delete, and manage permissions for {ODH_PRODUCT_NAME} users in OpenShift.{' '}
<ExternalLink
text="Learn more about OpenShift user management"
to="https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/index"
to="https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_openshift_ai/managing-users-and-groups"
/>
</Alert>
</StackItem>
Expand Down
2 changes: 1 addition & 1 deletion manifests/common/apps/jupyter/jupyter-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ spec:
ii. Enter your credentials and click **Log in** (or equivalent for your identity provider).
If you see **Error 403: Forbidden**, you are not in the default user group or the default administrator group for OpenShift AI. Contact your administrator so that they can add you to the correct group using [Adding users for Red Hat OpenShift AI](https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/adding-users-for-openshift-data-science_useradd).
If you see **Error 403: Forbidden**, you are not in the default user group or the default administrator group for OpenShift AI. Contact your administrator so that they can add you to the correct group using [Adding users for Red Hat OpenShift AI](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_openshift_ai/managing-users-and-groups#adding-users-to-user-groups_managing-rhoai).
3. Start a notebook server.
Expand Down
12 changes: 6 additions & 6 deletions manifests/common/apps/jupyter/jupyter-docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ spec:
type: how-to
description: |-
Install additional python packages into your notebook server.
url: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/working_on_data_science_projects/index#installing-python-packages-on-your-notebook-server_nb-server/index
url: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_connected_applications/using_the_jupyter_application#installing-python-packages-on-your-notebook-server_connected-apps
durationMinutes: 15
---
apiVersion: dashboard.opendatahub.io/v1
Expand All @@ -25,7 +25,7 @@ spec:
appName: jupyter
description: |-
Update the settings or the notebook image on your notebook server.
url: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/working_on_data_science_projects/index#updating-notebook-server-settings-by-restarting-your-server_nb-server/index
url: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_resources/managing-notebook-servers_notebook-mgmt
durationMinutes: 15
---
apiVersion: dashboard.opendatahub.io/v1
Expand All @@ -35,12 +35,12 @@ metadata:
annotations:
opendatahub.io/categories: 'Data management,Notebook environments'
spec:
displayName: How to use data from Amazon S3 buckets
displayName: How to use data from an S3-compatible object store
appName: jupyter
type: how-to
description: |-
Connect to data in S3 Storage using environment variables.
url: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/integrating_data_from_amazon_s3/index
Connect to data in S3 Storage.
url: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_data_in_an_s3-compatible_object_store/index
durationMinutes: 15
---
apiVersion: dashboard.opendatahub.io/v1
Expand All @@ -55,5 +55,5 @@ spec:
type: how-to
description: |-
See which packages are installed into your running notebook server.
url: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html-single/working_on_data_science_projects/index#viewing-python-packages-installed-on-your-notebook-server_nb-server/index
url: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/working_with_connected_applications/using_the_jupyter_application#viewing-python-packages-installed-on-your-notebook-server_connected-apps
durationMinutes: 15
8 changes: 4 additions & 4 deletions manifests/rhoai/addon/apps/nvidia/nvidia-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,14 @@ spec:
csvName: gpu-operator-certified
docsLink: https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/openshift/contents.html
quickStart: gpu-quickstart
getStartedLink: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/enabling-gpu-support-in-openshift-data-science_user-mgmt
getStartedLink: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_openshift_ai/enabling_accelerators#enabling-nvidia-gpus_managing-rhoai
enable:
title: Enable NVIDIA GPU Add-on
title: Enable NVIDIA GPUs
actionLabel: Enable
description: Clicking enable adds the NVIDIA GPU Add-on card to the Enabled page
linkPreface: |-
Before enabling, be sure you have installed the NVIDIA GPU Add-on:
link: https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/enabling-gpu-support-in-openshift-data-science_user-mgmt
link: https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_openshift_ai/enabling_accelerators#enabling-nvidia-gpus_managing-rhoai
validationConfigMap: nvidia-validation-result
getStartedMarkDown: >-
# NVIDIA GPU Add-on
Expand All @@ -36,4 +36,4 @@ spec:
The NVIDIA GPU Operator uses the operator framework within Kubernetes to automate the management of all NVIDIA software components needed to provision GPU. These components include the NVIDIA drivers (to enable CUDA), Kubernetes device plugin for GPUs, the NVIDIA Container Toolkit, automatic node labelling using GFD, DCGM based monitoring and others.
Documentation :
[Enabling GPU Support in OpenShift AI](https://access.redhat.com/documentation/en-us/red_hat_openshift_data_science/1/html/managing_users_and_user_resources/enabling-gpu-support-in-openshift-data-science_user-mgmt)
[Enabling GPU Support in OpenShift AI](https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/managing_openshift_ai/enabling_accelerators#enabling-nvidia-gpus_managing-rhoai)
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
tasks:
- title: Annotate your Python Model API for Service Discovery
description: >-
Service Discovery is a 3scale feature that helps you import services from an OpenShift cluster. The Red Hat 3scale API Management instance provided by Red Hat OpenShift API Management has the [Service Discovery](https://access.redhat.com/documentation/en-us/red_hat_3scale_api_management/2.10/html/admin_portal_guide/service_discovery_from_openshift_to_3scale) feature enabled and pre-configured.
Service Discovery is a 3scale feature that helps you import services from an OpenShift cluster. The Red Hat 3scale API Management instance provided by Red Hat OpenShift API Management has the [Service Discovery](https://docs.redhat.com/en/documentation/red_hat_3scale_api_management/2.14/html/admin_portal_guide/service_discovery_from_openshift_to_3scale_api_management) feature enabled and pre-configured.
When Service Discovery is configured, 3scale scans for discoverable API services that are running in the same OpenShift cluster and automatically imports the associated API definitions into 3scale. Additionally, 3scale can update the API integration and its specification, based on OpenAPI Specification (OAS), to resynchronize them with the cluster.
Expand Down
4 changes: 2 additions & 2 deletions manifests/rhoai/addon/apps/rhoam/rhoam-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
category: Red Hat managed
support: redhat
docsLink: https://access.redhat.com/documentation/en-us/red_hat_openshift_api_management
docsLink: https://docs.redhat.com/en/documentation/red_hat_openshift_api_management
quickStart: deploy-model-rhoam
getStartedLink: https://console.redhat.com/openshift/details/<CLUSTER_ID/>#addOns
getStartedMarkDown: >-
Expand All @@ -37,4 +37,4 @@ spec:
For more information visit:
[https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-api-management](https://www.redhat.com/en/technologies/cloud-computing/openshift/openshift-api-management)
[https://access.redhat.com/documentation/en-us/red_hat_openshift_api_management](https://access.redhat.com/documentation/en-us/red_hat_openshift_api_management)
[https://docs.redhat.com/en/documentation/red_hat_openshift_api_management](https://docs.redhat.com/en/documentation/red_hat_openshift_api_management)
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ spec:
- Previously installed and configured Kubernetes, including access to **kubectl**.
- An editor suitable for editing YAML files.
- Your SEP (Starburst Enterprise) license file.
- The latest OpenShift Container Platform (OCP) client for your platform as described in the [OpenShift documentation](https://docs.openshift.com/container-platform/latest/cli_reference/openshift_cli/getting-started-cli.html) and the **oc** executable copied into your path, usually **/usr/local/bin.**
- The latest OpenShift Container Platform (OCP) client for your platform as described in the [OpenShift documentation](https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/cli_tools/openshift-cli-oc) and the **oc** executable copied into your path, usually **/usr/local/bin.**
## Installation
Expand Down
2 changes: 1 addition & 1 deletion manifests/rhoai/shared/apps/rhoai/rhoai-app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ metadata:
spec:
img: >-
<svg xmlns="http://www.w3.org/2000/svg" width="38" height="38" viewBox="0 0 38 38"><g id="uuid-fb69441b-b57f-4918-99bb-aad41e7175f0"><rect x="1" y="1" width="36" height="36" rx="9" ry="9" stroke-width="0"/><path d="m28,2.25c4.27336,0,7.75,3.47664,7.75,7.75v18c0,4.27336-3.47664,7.75-7.75,7.75H10c-4.27336,0-7.75-3.47664-7.75-7.75V10c0-4.27336,3.47664-7.75,7.75-7.75h18m0-1.25H10C5.02944,1,1,5.02943,1,10v18c0,4.97057,4.02944,9,9,9h18c4.97056,0,9-4.02943,9-9V10c0-4.97057-4.02944-9-9-9h0Z" fill="#4d4d4d" stroke-width="0"/></g><g id="uuid-2ba0340d-2b48-4a88-9260-2cfffdbae283"><path d="m19,29.625c-.10449,0-.20898-.02637-.30371-.07861l-9-5c-.20264-.11279-.32617-.32812-.32129-.56006.00537-.23193.13818-.44189.3457-.54541l2-1c.30859-.15381.68506-.02832.83838.27979.1543.30859.0293.68408-.27979.83838l-.93994.47021,7.66064,4.25586,7.66113-4.25586-.94043-.47021c-.30859-.1543-.43457-.52979-.2793-.83838.1543-.31006.53125-.43262.83789-.27979l2,1c.20801.10352.34082.31348.3457.54541s-.11914.44727-.32129.56006l-9,5c-.09473.05225-.19922.07861-.30371.07861Z" fill="#e00" stroke-width="0"/><path d="m19.15332,21.39404c-.33887-.08643-.6748.11865-.75928.45264-.20068.79443-.79541,1.39893-1.51416,1.54004-1.02734.20117-2.06396-.65674-2.27197-1.53076-.05322-.22607-.05273-.46924.00293-.72266.00659-.03027-.00073-.05914.00134-.08917.00299-.04205.00726-.08258.00183-.1236-.00525-.04016-.01801-.07629-.0307-.11414-.0127-.03827-.02405-.07526-.04382-.11029-.01965-.03497-.04541-.06378-.07141-.09442-.02582-.03052-.04999-.0603-.08167-.08557-.03271-.02625-.07013-.04376-.10822-.06323-.02631-.01343-.04675-.03436-.07556-.04419-.5177-.17749-.97192-.45697-1.35571-.79919.0517.00305.10065.0155.15308.0155,1.44727,0,2.625-1.17773,2.625-2.625,0-.34521-.27979-.625-.625-.625s-.625.27979-.625.625c0,.7583-.6167,1.375-1.375,1.375-.75385,0-1.36646-.6098-1.37366-1.36194-.00006-.00507-.00134-.00995-.00134-.01501-.00586-1.66943,1.32764-3.18848,2.47852-3.38184.29053-.04785.64404-.021.80615.00244.76904.1123,1.32617.51465,1.6582.83252.24902.23926.64404.23096.8833-.01904.23877-.24902.23047-.64453-.01904-.8833-.46338-.44434-1.24561-1.00684-2.34229-1.16748-.10547-.0166-.6582-.08789-1.19336.00244-.06549.01099-.13196.04083-.19788.05688.25311-1.03925,1.18536-1.81567,2.30139-1.81567,1.30957,0,2.375,1.06543,2.375,2.375,0,.02484.01135.04596.01416.07001.00488.04248.01147.08246.02466.12231.01257.03827.02881.07251.04816.10712.01953.0351.0401.06714.06598.09784.026.03094.05432.05682.08582.08221.03064.02478.0614.04639.09668.06519.03741.01996.07605.03339.11743.04553.02295.00677.04156.02136.06567.02551.03558.00623.07062.00903.10571.00916.00024,0,.00049.00012.00073.00012.00012,0,.00018-.00006.00031-.00006.00024,0,.00043.00006.00067.00006.08008,0,.15649-.01776.22833-.04633.02466-.00977.04431-.02618.06732-.03888.04413-.02429.08661-.04926.12378-.08344.02185-.02008.03796-.04382.05676-.06683.02966-.03607.05658-.07257.07776-.11523.01434-.02875.02295-.05872.03278-.08978.00842-.02667.02356-.04968.0285-.07806.26855-1.55762,1.4082-2.48145,2.36133-2.48145h.01562c.75293.00781,1.33008.55762,1.54297.79346.23047.25732.625.27588.88281.04541.25586-.23096.27637-.62646.04492-.88232-.32324-.3584-1.20996-1.19336-2.45703-1.20654h-.03027c-1.1449,0-2.20697.68921-2.89203,1.74573-.63739-1.04224-1.77582-1.74573-3.08453-1.74573-1.99902,0-3.625,1.62598-3.625,3.625,0,.0282.01245.05225.01605.07947-1.1131.8244-2.01984,2.26544-2.01575,3.91888,0,.00061-.00031.00104-.00031.00165,0,.00031.00012.00061.00012.00092,0,.00037-.00012.00067-.00012.00104.00629,1.88336,1.18011,3.58411,2.95685,4.38977-.0105.2558.00208.50848.06024.75281.30664,1.29199,1.62891,2.52344,3.16943,2.52344.18359,0,.37061-.01758.55859-.05469,1.19141-.23389,2.16699-1.19922,2.48535-2.45996.08496-.33447-.11719-.6748-.45215-.75928Z" fill="#fff" stroke-width="0"/><path d="m20.62372,17.14917l.763-1.52417h2.15021c.27264.5885.86511,1,1.55487,1,.94629,0,1.7168-.77002,1.7168-1.7168s-.77051-1.7168-1.7168-1.7168c-.75909,0-1.39758.49884-1.62341,1.18359h-2.46838c-.23633,0-.45312.13379-.55859.3457l-.78668,1.5733c-.17731-.06207-.36475-.1026-.56293-.1026-.94678,0-1.7168.77002-1.7168,1.7168s.77002,1.7168,1.7168,1.7168c.94629,0,1.7168-.77002,1.7168-1.7168,0-.2738-.07037-.52917-.18488-.75903Zm4.46808-2.70776c.25781,0,.4668.20947.4668.4668s-.20898.4668-.4668.4668-.4668-.20947-.4668-.4668.20898-.4668.4668-.4668Zm-6,3.93359c-.25732,0-.4668-.20947-.4668-.4668s.20947-.4668.4668-.4668c.25781,0,.4668.20947.4668.4668s-.20898.4668-.4668.4668Z" fill="#fff" stroke-width="0"/><path d="m25.0918,17.375c-.68976,0-1.28223.4115-1.55487,1h-1.53693c-.34473,0-.625.27979-.625.625v2.53693c-.58838.27258-1,.86481-1,1.55487,0,.94678.77051,1.7168,1.7168,1.7168s1.7168-.77002,1.7168-1.7168c0-.75946-.49902-1.39771-1.18359-1.62347v-1.84332h.84338c.22583.68475.86432,1.18359,1.62341,1.18359.94629,0,1.7168-.77002,1.7168-1.7168s-.77051-1.7168-1.7168-1.7168Zm-3,6.18359c-.25781,0-.4668-.20947-.4668-.4668s.20898-.4668.4668-.4668.4668.20947.4668.4668-.20898.4668-.4668.4668Zm3-4c-.25781,0-.4668-.20947-.4668-.4668s.20898-.4668.4668-.4668.4668.20947.4668.4668-.20898.4668-.4668.4668Z" fill="#fff" stroke-width="0"/></g></svg>
getStartedLink: 'https://access.redhat.com/documentation/en-us/red_hat_openshift_ai_cloud_service/1/html/openshift_ai_tutorial_-_fraud_detection_example/index'
getStartedLink: 'https://docs.redhat.com/en/documentation/red_hat_openshift_ai_cloud_service/1/html/openshift_ai_tutorial_-_fraud_detection_example/index'
displayName: Red Hat OpenShift AI
support: red hat
provider: Red Hat
Expand Down
Loading

0 comments on commit 4d29174

Please sign in to comment.