Fix: Route to website links instead of ./docs (#4575)

<!-- Thanks for sending a pull request! Here are some tips for you: -->

#### What type of PR is this?

Fix

#### What this PR does / why we need it

There are dead-links on Readme, and reported by armadactl.

Co-authored-by: Dave Gantenbein <dave@gr-oss.io>

Author: nikola-jokic

README.md

@@ -3,30 +3,30 @@
  <p>
   <a href="https://circleci.com/gh/armadaproject/armada"><img src="https://circleci.com/gh/helm/helm.svg?style=shield" alt="CircleCI"></a>
   <a href="https://goreportcard.com/report/github.com/armadaproject/armada"><img src="https://goreportcard.com/badge/github.com/armadaproject/armada" alt="Go Report Card"></a>
-  <a href="https://artifacthub.io/packages/helm/gresearch/armada" title="Go to Artifact Hub"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/armada" alt="Artifact Hub"></a>        
+  <a href="https://artifacthub.io/packages/helm/gresearch/armada" title="Go to Artifact Hub"><img src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/armada" alt="Artifact Hub"></a>
   <a href="https://insights.linuxfoundation.org/project/armada" title="Click to view project insights and health checks"><img src="https://insights.linuxfoundation.org/api/badge/health-score?project=armada" alt="LFX Health Score"></a>
  </p>
 </div>
 
 # Armada
 
-Armada is a system built on top of [Kubernetes](https://kubernetes.io/docs/concepts/overview/) for running batch workloads. With Armada as middleware for batch, Kubernetes can be a common substrate for batch and service workloads.  Armada is used in production and can run millions of jobs per day across tens of thousands of nodes. 
+Armada is a system built on top of [Kubernetes](https://kubernetes.io/docs/concepts/overview/) for running batch workloads. With Armada as middleware for batch, Kubernetes can be a common substrate for batch and service workloads. Armada is used in production and can run millions of jobs per day across tens of thousands of nodes.
 
 Armada addresses the following limitations of Kubernetes:
 
 1. Scaling a single Kubernetes cluster beyond a certain size is [challenging](https://openai.com/blog/scaling-kubernetes-to-7500-nodes/). Hence, Armada is designed to effectively schedule jobs across many Kubernetes clusters. Many thousands of nodes can be managed by Armada in this way.
 2. Achieving very high throughput using the in-cluster storage backend, etcd, is [challenging](https://etcd.io/docs/v3.5/op-guide/performance/). Hence, Armada performs queueing and scheduling out-of-cluster using a specialized storage layer. This allows Armada to maintain queues composed of millions of jobs.
 3. The default [kube-scheduler](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-scheduler/) is not suitable for batch. Instead, Armada includes a novel multi-Kubernetes cluster scheduler with support for important batch scheduling features, such as:
-   * Fair queuing and scheduling across multiple users. Based on dominant resource fairness.
-   * Resource and job scheduling rate limits.
-   * Gang-scheduling, i.e., atomically scheduling sets of related jobs.
-   * Job preemption, both to run urgent jobs in a timely fashion and to balance resource allocation between users.
+    - Fair queuing and scheduling across multiple users. Based on dominant resource fairness.
+    - Resource and job scheduling rate limits.
+    - Gang-scheduling, i.e., atomically scheduling sets of related jobs.
+    - Job preemption, both to run urgent jobs in a timely fashion and to balance resource allocation between users.
 
 Armada also provides features to help manage large compute clusters effectively, including:
 
-* Detailed analytics exposed via [Prometheus](https://prometheus.io/) showing how the system behaves and how resources are allocated.
-* Automatically removing nodes exhibiting high failure rates from consideration for scheduling.
-* A mechanism to earmark nodes for a particular set of jobs, but allowing them to be used by other jobs when not used for their primary purpose.
+- Detailed analytics exposed via [Prometheus](https://prometheus.io/) showing how the system behaves and how resources are allocated.
+- Automatically removing nodes exhibiting high failure rates from consideration for scheduling.
+- A mechanism to earmark nodes for a particular set of jobs, but allowing them to be used by other jobs when not used for their primary purpose.
 
 Armada is designed with the enterprise in mind; all components are secure and highly available.
 
@@ -53,6 +53,7 @@ Alternatively, you can install Armada manually by using the Helm charts defined
 Armada also provides a command-line interface, `armadactl`, which can be used to interact with the Armada system.
 
 To install `armadactl`, run the following script:
+
 ```bash
 scripts/get-armadactl.sh
 ```
@@ -69,20 +70,28 @@ allowing you to run multiple processes with a single command.
 Goreman will build the components from source and run them locally, making it easy to test changes quickly.
 
 1. Install `goreman`:
+
     ```shell
     go install github.com/mattn/goreman@latest
     ```
+
 2. Start dependencies:
+
     ```shell
     docker-compose -f _local/docker-compose-deps.yaml up -d
     ```
-   - **Note**: Images can be overridden using environment variables:
-     `REDIS_IMAGE`, `POSTGRES_IMAGE`, `PULSAR_IMAGE`, `KEYCLOAK_IMAGE`
+
+    - **Note**: Images can be overridden using environment variables:
+      `REDIS_IMAGE`, `POSTGRES_IMAGE`, `PULSAR_IMAGE`, `KEYCLOAK_IMAGE`
+
 3. Initialize databases and Kubernetes resources:
+
     ```shell
     scripts/localdev-init.sh
     ```
+
 4. Start Armada components:
+
     ```shell
     goreman -f _local/procfiles/no-auth.Procfile start
     ```
@@ -92,30 +101,36 @@ Goreman will build the components from source and run them locally, making it ea
 To run Armada with OIDC authentication enabled using Keycloak:
 
 1. Start dependencies with the auth profile:
+
     ```shell
     docker-compose -f _local/docker-compose-deps.yaml --profile auth up -d
     ```
-   This starts Redis, PostgreSQL, Pulsar, and Keycloak with a pre-configured realm.
+
+    This starts Redis, PostgreSQL, Pulsar, and Keycloak with a pre-configured realm.
 
 2. Initialize databases and Kubernetes resources:
+
     ```shell
     scripts/localdev-init.sh
     ```
 
 3. Start Armada components with auth configuration:
+
     ```shell
     goreman -f _local/procfiles/auth.Procfile start
     ```
 
 4. Use armadactl with OIDC authentication:
+
     ```shell
     armadactl --config _local/.armadactl.yaml --context auth-oidc get queues
     ```
 
 #### Authentication Configuration
 
 The auth profile configures:
-- **Keycloak**: OIDC provider running on http://localhost:8180 with pre-configured realm, users, and clients
+
+- **Keycloak**: OIDC provider running on <http://localhost:8180> with pre-configured realm, users, and clients
 - **Users**: `admin/admin` (admin group), `user/password` (users group) for both OIDC and basic auth
 - **Service accounts**: Executor and Scheduler use OIDC Client Credentials flow for service-to-service authentication
 - **APIs**: Server, Lookout, and Binoculars APIs are secured with OIDC and basic auth
@@ -133,11 +148,13 @@ goreman -f _local/procfiles/fake-executor.Procfile start
 ```
 
 The fake executor simulates:
+
 - 2 virtual nodes with 8 CPUs and 32Gi memory each
 - Pod lifecycle management without actual container execution
 - Resource allocation and job state transitions
 
 This is useful for:
+
 - Testing Armada's scheduling logic
 - Development when Kubernetes is not available
 - Integration testing of job flows
@@ -147,7 +164,7 @@ This is useful for:
 All Procfiles are located in `_local/procfiles/`:
 
 | Procfile                 | Description                                       |
-|--------------------------|---------------------------------------------------|
+| ------------------------ | ------------------------------------------------- |
 | `no-auth.Procfile`       | Standard setup without authentication             |
 | `auth.Procfile`          | Standard setup with OIDC authentication           |
 | `fake-executor.Procfile` | Uses fake executor for testing without Kubernetes |
@@ -157,6 +174,7 @@ Restart individual processes with `goreman restart <component>` (e.g., `goreman
 ### Service Ports
 
 Run `goreman run status` to check the status of the processes (running processes are prefixed with `*`):
+
 ```shell
 $ goreman run status
 *server
@@ -173,7 +191,7 @@ $ goreman run status
 Goreman exposes services on the following ports:
 
 | Service                    | Port  | Description         |
-|----------------------------|-------|---------------------|
+| -------------------------- | ----- | ------------------- |
 | Server gRPC                | 50051 | Armada gRPC API     |
 | Server HTTP                | 8081  | REST API & Health   |
 | Server Metrics             | 9000  | Prometheus metrics  |
@@ -197,12 +215,13 @@ Goreman exposes services on the following ports:
 
 For documentation, see the following:
 
-- [System overview](./docs/system_overview.md)
-- [Scheduler](./docs/scheduler.md)
-- [User guide](./docs/user.md)
-- [Development guide](./docs/developer.md)
+- [Overview](https://armadaproject.io/)
+- [Getting Started](https://armadaproject.io/getting-started)
+- [Architecture](https://armadaproject.io/understanding-armada/architecture)
+- [User guide](https://armadaproject.io/user-guide)
+- [Development guide](https://armadaproject.io/developer-guide)
 - [Release notes/Version history](https://github.com/armadaproject/armada/releases)
-- [API Documentation](./docs/developer/api.md)
+- [API Documentation](https://armadaproject.io/user-guide/api)
 
 We expect readers of the documentation to have a basic understanding of Docker and Kubernetes; see, e.g., the following links:
 
@@ -219,5 +238,4 @@ For more information about contributing to Armada see [CONTRIBUTING.md](https://
 
 ## Discussion
 
-If you are interested in discussing Armada you can find us on  [![slack](https://img.shields.io/badge/slack-armada-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/?redir=%2Farchives%2FC03T9CBCEMC)
-
+If you are interested in discussing Armada you can find us on [![slack](https://img.shields.io/badge/slack-armada-brightgreen.svg?logo=slack)](https://cloud-native.slack.com/?redir=%2Farchives%2FC03T9CBCEMC)

internal/lookoutui/README.md

@@ -54,7 +54,7 @@ real-time. This serves the web app on
 [http://localhost:3000](http://localhost:3000). It proxies API requests to the
 target defined by your `PROXY_TARGET` environment variable, or otherwise your
 locally-running instance of the Lookout server at `http://localhost:10000`
-(please see [the main developer docs](../../docs/developer/ui.md) for details
+(please see [the main developer docs](https://armadaproject.io/developer-guide) for details
 of how to set this up).
 
 ```bash

pkg/client/command_line.go

@@ -202,7 +202,7 @@ func ExtractCommandlineArmadaApiConnectionDetails() (*ApiConnectionDetails, erro
 
 	} else {
 		fmt.Print("No context defined. This method of providing connection details will soon be deprecated, " +
-			"the new configuration format is explained here: github.com/armadaproject/armada/blob/master/docs/demo.md#armadactl-configuration\n")
+			"the new configuration format is explained here: https://armadaproject.io/user-guide/cli#configuration\n")
 		err = viper.Unmarshal(apiConnectionDetails)
 	}
 

scripts/get-armadactl.sh

@@ -12,26 +12,26 @@ fi
 
 # Determine architecture
 get_arch() {
-    case $(uname -m) in
-        "x86_64" | "amd64" ) echo "amd64" ;;
-        "i386" | "i486" | "i586") echo "386" ;;
-        "aarch64" | "arm64" | "arm") echo "arm64" ;;
-        "mips64el") echo "mips64el" ;;
-        "mips64") echo "mips64" ;;
-        "mips") echo "mips" ;;
-        *) echo "unknown" ;;
-    esac
+  case $(uname -m) in
+  "x86_64" | "amd64") echo "amd64" ;;
+  "i386" | "i486" | "i586") echo "386" ;;
+  "aarch64" | "arm64" | "arm") echo "arm64" ;;
+  "mips64el") echo "mips64el" ;;
+  "mips64") echo "mips64" ;;
+  "mips") echo "mips" ;;
+  *) echo "unknown" ;;
+  esac
 }
 
 ARCH=$(get_arch)
 if [ "$SYSTEM" = "darwin" ]; then
-    ARCH="all"
+  ARCH="all"
 fi
 
 # Get latest release
 get_latest_release() {
-    curl --silent "https://api.github.com/repos/armadaproject/armada/releases/latest" | \
-    grep '"tag_name":' | \
+  curl --silent "https://api.github.com/repos/armadaproject/armada/releases/latest" |
+    grep '"tag_name":' |
     sed -E 's/.*"([^"]+)".*/\1/'
 }
 
@@ -44,8 +44,8 @@ ARMADACTL_URL="https://github.com/armadaproject/armada/releases/download/$VERSIO
 echo "Downloading armadactl $VERSION for $SYSTEM/$ARCH"
 
 # Download and untar/unzip armadactl
-if curl -sL $ARMADACTL_URL | sh -c "$UNARCHIVE" ; then
-	echo "armadactl downloaded successfully"
+if curl -sL "$ARMADACTL_URL" | sh -c "$UNARCHIVE"; then
+  echo "armadactl downloaded successfully"
 
   # Move armadactl binary to a directory in user's PATH
   TARGET_DIR="$HOME/bin" # Change this to the desired target directory in your user's home
@@ -56,8 +56,8 @@ if curl -sL $ARMADACTL_URL | sh -c "$UNARCHIVE" ; then
   echo "armadactl is now available on your PATH"
 
 else
-	echo "Something is amiss!"
-	echo "Please visit:"
-	echo "  - https://github.com/armadaproject/armada/releases/latest"
-	echo "to find the latest armadactl binary for your platform"
+  echo "Something is amiss!"
+  echo "Please visit:"
+  echo "  - https://github.com/armadaproject/armada/releases/latest"
+  echo "to find the latest armadactl binary for your platform"
 fi