Merge pull request #908 from run-ai/doc-fixes-v2

yarongol · web-flow · commit a5a9fcfb2a9c · 2024-08-05T20:18:34.000+03:00
fixes
diff --git a/docs/Researcher/Walkthroughs/quickstart-inference.md b/docs/Researcher/Walkthroughs/quickstart-inference.md
@@ -12,7 +12,7 @@ To complete this Quickstart you must have:
 
 * Run:ai software installed on your Kubernetes cluster. See: [Installing Run:ai on a Kubernetes Cluster](../../admin/runai-setup/installation-types.md). There are additional prerequisites for running inference. See [cluster installation prerequisites](../../admin/runai-setup/cluster-setup/cluster-prerequisites.md#inference) for more information.
 * Run:ai CLI installed on your machine. See: [Installing the Run:ai Command-Line Interface](../../admin/researcher-setup/cli-install.md)
-* You must have *ML Engineer* access rights. See [Adding, Updating and Deleting Users](../../admin/admin-ui-setup/admin-ui-users.md) for more information.
+* You must have *ML Engineer* access rights. See [Adding, Updating and Deleting Users](../../admin/runai-setup/authentication/users.md) for more information.
 
 ## Step by Step Walkthrough
 
diff --git a/docs/Researcher/user-interface/workspaces/overview.md b/docs/Researcher/user-interface/workspaces/overview.md
@@ -17,7 +17,7 @@ Researchers can only view and use workspaces that are created under projects the
 
 ![](img/1-Workspaces-grid.png)
 
-Workspaces can be created with just a few clicks of a button. See [Workspace creation](create/workspace.md).  
+Workspaces can be created with just a few clicks of a button. See [Workspace creation](create/workspace-v2.md).  
 
 Workspaces can be stopped and started to save expensive resources without losing complex environment configurations.
 
diff --git a/docs/admin/aiinitiatives/org/departments.md b/docs/admin/aiinitiatives/org/departments.md
@@ -112,9 +112,9 @@ To create a new access rule for a department:
 3. Click +ACCESS RULE  
 4. Select a subject  
 5. Select or enter the subject identifier:  
-   * User Email for a local user created in Run:ai or for SSO user as recognized by the IDP  
-   * Group name as recognized by the IDP  
-   * Application name as created in Run:ai  
+    * User Email for a local user created in Run:ai or for SSO user as recognized by the IDP  
+    * Group name as recognized by the IDP  
+    * Application name as created in Run:ai  
 6. Select a role  
 7. Click SAVE RULE  
 8. Click CLOSE
diff --git a/docs/admin/aiinitiatives/org/projects.md b/docs/admin/aiinitiatives/org/projects.md
@@ -171,9 +171,9 @@ To create a new access rule for a project:
 3. Click +ACCESS RULE  
 4. Select a subject  
 5. Select or enter the subject identifier:  
-   1. User Email for a local user created in Run:ai or for SSO user as recognized by the IDP  
-   2. Group name as recognized by the IDP  
-   3. Application name as created in Run:ai  
+    1. User Email for a local user created in Run:ai or for SSO user as recognized by the IDP  
+    2. Group name as recognized by the IDP  
+    3. Application name as created in Run:ai  
 6. Select a role  
 7. Click SAVE RULE  
 8. Click CLOSE
diff --git a/docs/admin/researcher-setup/researcher-setup-intro.md b/docs/admin/researcher-setup/researcher-setup-intro.md
@@ -18,7 +18,7 @@ To submit workloads with Run:ai, the Researcher must be provided with a _Project
 
 ## Provide access to the Run:ai User Interface
 
-See [Setting up users](../admin-ui-setup/admin-ui-users.md) for further information on how to provide access to users.  
+See [Setting up users](../runai-setup/authentication/users.md) for further information on how to provide access to users.  
 
 ## Schedule an Onboarding Session
 
diff --git a/docs/admin/runai-setup/cluster-setup/cluster-install.md b/docs/admin/runai-setup/cluster-setup/cluster-install.md
@@ -87,7 +87,7 @@ To perform these tasks. See [Set Node Roles](../config/node-roles.md).
 
 ## Next Steps
 
-* Set up Run:ai Users [Working with Users](../../admin-ui-setup/admin-ui-users.md).
+* Set up Run:ai Users [Working with Users](../../runai-setup/authentication/users.md).
 * Set up Projects for Researchers [Working with Projects](../../aiinitiatives/org/projects.md).
 * Set up Researchers to work with the Run:ai Command-line interface (CLI). See  [Installing the Run:ai Command-line Interface](../../researcher-setup/cli-install.md) on how to install the CLI for users.
 * Review [advanced setup and maintenance](../config/overview.md) scenarios.
diff --git a/docs/admin/runai-setup/cluster-setup/cluster-prerequisites.md b/docs/admin/runai-setup/cluster-setup/cluster-prerequisites.md
@@ -37,7 +37,7 @@ Run:ai requires Kubernetes. Run:ai is been certified with the following Kubernet
 
 | Kubernetes Distribution           | Description | Installation Notes |
 |-----------------------------------|-------------|--------------------|
-| Vanilla Kubernetes                       |  Using no specific distribution but rather k8s vanilla installation  |  See instructions for a simple (non-production-ready) [Kubernetes Installation](install-k8s.md) script. |
+| Vanilla Kubernetes                       |  Using no specific distribution but rather k8s vanilla installation  |   |
 | OCP | OpenShift Container Platform       |   The Run:ai operator is [certified](https://catalog.redhat.com/software/operators/detail/60be3acc3308418324b5e9d8){target=_blank} for OpenShift by Red Hat. |
 | EKS | Amazon Elastic Kubernetes Service  |  |
 | AKS | Azure Kubernetes Services          |   |
diff --git a/docs/admin/runai-setup/cluster-setup/dgx-bundle.md b/docs/admin/runai-setup/cluster-setup/dgx-bundle.md
@@ -66,7 +66,7 @@ Save the URL for future use.
 Post installation, you will want to:
 
 * (Mandatory) Set up [Researcher Access Control](../authentication/researcher-authentication.md). Without this, the Job Submit form will not work.
-* Set up Run:ai Users [Working with Users](../../admin-ui-setup/admin-ui-users.md).
+* Set up Run:ai Users [Working with Users](../../runai-setup/authentication/users.md).
 * Set up Projects for Researchers [Working with Projects](../../aiinitiatives/org/projects.md).
 
 ## Troubleshooting
diff --git a/docs/admin/runai-setup/self-hosted/k8s/next-steps.md b/docs/admin/runai-setup/self-hosted/k8s/next-steps.md
@@ -4,7 +4,7 @@ title: Self Hosted installation over Kubernetes - Next Steps
 # Next Steps
 
  
-* Create additional [I Users](../../../admin-ui-setup/admin-ui-users.md).
+* Create additional [I Users](../../../runai-setup/authentication/users.md).
 * Set up [Project-based Researcher Access Control](../../authentication/researcher-authentication.md).
 * Set up Researchers to work with the Run:ai Command-line interface (CLI). See [Installing the Run:ai Command-line Interface](../../../researcher-setup/cli-install.md) on how to install the CLI for users.
 * Review [advanced setup and maintenace](../../config/overview.md) scenarios.
diff --git a/docs/admin/runai-setup/self-hosted/ocp/next-steps.md b/docs/admin/runai-setup/self-hosted/ocp/next-steps.md
@@ -4,7 +4,7 @@ title: Self Hosted installation over OpenShift - Next Steps
 # Next Steps
 
  
-* Create additional [Run:ai Users](../../../admin-ui-setup/admin-ui-users.md).
+* Create additional [Run:ai Users](../../../runai-setup/authentication/users.md).
 * Set up [Project-based Researcher Access Control](../../authentication/researcher-authentication.md).
 * Set up Researchers to work with the Run:ai Command-line interface (CLI). See [Installing the Run:ai Command-line Interface](../../../researcher-setup/cli-install.md) on how to install the CLI for users.
 * Review [advanced setup and maintenace](../../config/overview.md) scenarios.
diff --git a/docs/home/whats-new-2-16.md b/docs/home/whats-new-2-16.md
@@ -54,7 +54,7 @@ date: 2023-Dec-4
 
 #### Authentication and Authorization
 
-* <!--  DONE RUN-13107/RUN-13108 - SSO users visibility-->SSO users who have logged into the system will now be visible in the *Users* table. In addition, added a column to the *Users* table for the type of user that was created (Local or SSO). For more information, see [Adding, Updating, and Deleting Users](../admin/admin-ui-setup/admin-ui-users.md#adding-updating-and-deleting-users).
+* <!--  DONE RUN-13107/RUN-13108 - SSO users visibility-->SSO users who have logged into the system will now be visible in the *Users* table. In addition, added a column to the *Users* table for the type of user that was created (Local or SSO). For more information, see [Adding, Updating, and Deleting Users](../admin/runai-setup/authentication/users.md).
 
 #### Policies
 
diff --git a/docs/home/whats-new-2-17.md b/docs/home/whats-new-2-17.md
@@ -17,7 +17,7 @@ date: 2024-Apr-14
 
 * <!-- RUN-14094/RUN-14095/RUN-10891/RUN-10892/RUN-12686/RUN-12687/RUN-12688/RUN-12689/RUN-13654/RUN-13655 Over provisioning -->Added functionality to configure over provisioning ratios for node pools running any kind of workload. Over provisioning assumes that workloads are either under utilizing or intermittently using GPUs. This indicates that the real utilization is lower than the actual GPU allocation requested. Over provisioning allows the administrator to condense more workloads on a single GPU than what the workload required. For more information, see [Optimize performance with Node Level Scheduler](../Researcher/scheduling/node-level-scheduler.md).
   
-* Added the *GPU Resource Optimization* feature to the UI. Now you can enable and configure *GPU Portion (Fraction) limit* and *GPU Memory Limit* from the UI. For more information, see [Compute resources UI with Dynamic Fractions](../Researcher/scheduling/dynamic-gpu-fractions.md#compute-reources-ui-with-dynamic-fractions-support). <!-- ADDLINK verify this is working-->
+* Added the *GPU Resource Optimization* feature to the UI. Now you can enable and configure *GPU Portion (Fraction) limit* and *GPU Memory Limit* from the UI. For more information, see [Compute resources UI with Dynamic Fractions](../Researcher/scheduling/dynamic-gpu-fractions.md#compute-resources-ui-with-dynamic-fractions-support). <!-- ADDLINK verify this is working-->
 
 * <!-- RUN-15071/RUN-15680 -- Demo Run:ai integration with OpenShift AI -->Added the ability to set Run:ai as the default scheduler for any project or namespace. This provides the administrator the ability to ensure that all workloads in a project or namespace are scheduled using the Run:ai scheduler. For more information, see [Setting Run:ai as default scheduler](../admin/aiinitiatives/org/projects.md).
 
@@ -85,7 +85,7 @@ date: 2024-Apr-14
 
 #### Monitoring and Analytics
 
-* <!-- RUN-12901/RUN-16507 - Dashboard improvements MVP -->Improved GPU Overview dashboard. This improvement provides rich and extensive GPU allocation and performance data and now has interactive tiles that provide direct links to the *Nodes*, *Workloads*, and *Departments* tables. Hover over tiles with graphs to show rich data in the selected time frame filter. Tiles with graphs can be downloaded as CSV files. The new dashboard is enabled by default. Use the *Go back to legacy view* to return to the previous dashboard style. For more information, see [Dashboard analysis](../admin/admin-ui-setup/dashboard-analysis.md#overview-dashboard).
+* <!-- RUN-12901/RUN-16507 - Dashboard improvements MVP -->Improved GPU Overview dashboard. This improvement provides rich and extensive GPU allocation and performance data and now has interactive tiles that provide direct links to the *Nodes*, *Workloads*, and *Departments* tables. Hover over tiles with graphs to show rich data in the selected time frame filter. Tiles with graphs can be downloaded as CSV files. The new dashboard is enabled by default. Use the *Go back to legacy view* to return to the previous dashboard style. For more information, see [Dashboard analysis](../admin/admin-ui-setup/dashboard-analysis.md).
 
 * <!-- RUN-15878/RUN-16796/RUN-15878/RUN-16085 omit Knative metrics and update supported metrics and hpa autoscaler -->Updated the knative and autoscaler metrics. Run:ai currently supports the following metrics:
 
@@ -126,7 +126,7 @@ Deprecated features will be available for **two** versions ahead of the notifica
 
 ### API support and endpoint deprecations
 
-The endpoints and parameters specified in the API reference are the ones that are officially supported by Run:ai. For more information about Run:ai's API support policy and deprecation process, see [Developer overview](../developer/overview-developer.md#overview-developer-documentation).
+The endpoints and parameters specified in the API reference are the ones that are officially supported by Run:ai. For more information about Run:ai's API support policy and deprecation process, see [Developer overview](../developer/overview-developer.md#administrator-api).
 
 #### Deprecated APIs and API fields
 
diff --git a/docs/home/whats-new-2-18.md b/docs/home/whats-new-2-18.md
@@ -85,9 +85,9 @@ date: 2024-June-14
 
 #### Single Sign On
 
-* <!-- TODO Change ticket numbers and description RUN-16859/RUN-16860-->Added support for Single Sign On using OpenShift v4 (OIDC based). When using OpenShift, you must first define OAuthClient which interacts with OpenShift's OAuth server to authenticate users and request access tokens. For more information, see [Single Sign-On](../admin/runai-setup/authentication/sso/).
+* <!-- TODO Change ticket numbers and description RUN-16859/RUN-16860-->Added support for Single Sign On using OpenShift v4 (OIDC based). When using OpenShift, you must first define OAuthClient which interacts with OpenShift's OAuth server to authenticate users and request access tokens. For more information, see [Single Sign-On](../admin/runai-setup/authentication/authentication-overview.md#single-sign-on-sso).
 
-* <!-- RUN-16788/RUN-16866 - OIDC Scopes -->Added OIDC scopes to authentication requests. OIDC Scopes are used to specify what access privileges are being requested for access tokens. The scopes associated with the access tokens determine what resource are available when they are used to access OAuth 2.0 protected endpoints. Protected endpoints may perform different actions and return different information based on the scope values and other parameters used when requesting the presented access token. For more information, see [UI configuration](../admin/runai-setup/authentication/sso/#step-1-ui-configuration).
+* <!-- RUN-16788/RUN-16866 - OIDC Scopes -->Added OIDC scopes to authentication requests. OIDC Scopes are used to specify what access privileges are being requested for access tokens. The scopes associated with the access tokens determine what resource are available when they are used to access OAuth 2.0 protected endpoints. Protected endpoints may perform different actions and return different information based on the scope values and other parameters used when requesting the presented access token. For more information, see [UI configuration](../admin/runai-setup/authentication/authentication-overview.md#single-sign-on-sso).
 
 #### Ownership protection
 
diff --git a/graveyard/install-k8s.md b/graveyard/install-k8s.md
diff --git a/graveyard/registry-integration.md b/graveyard/registry-integration.md
diff --git a/graveyard/whats-new-2-9.md b/graveyard/whats-new-2-9.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -123,7 +123,6 @@ nav:
       - 'home/whats-new-2-16.md'
       - 'Version 2.15' : 'home/whats-new-2-15.md'
       - 'Version 2.13' : 'home/whats-new-2-13.md'
-      - 'Version 2.9' : 'home/whats-new-2-9.md'
     - 'Changelog':
       - 'Hot Fixes for 2.17' : 'home/changelog/hotfixes-2-17.md'
       - 'Hot Fixes for 2.16' : 'home/changelog/hotfixes-2-16.md'
