Merge branch 'main' into chrischinch/docs-updates

# Conflicts:
#	docs/references/developers/running-locally.md
#	package-lock.json
#	package.json

Author: ChrisChinchilla

.github/workflows/pr-checks.yml

@@ -4,14 +4,16 @@ on:
   pull_request:
     types: [opened, synchronize, reopened]
 
-
 jobs:
-  build:
-    name: Build
+  spell-check:
+    name: Spell Check
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
 
       - name: Setup Environment
-        uses: ./.github/actions/setup-environment
+        uses: ./.github/actions/setup-environment
+
+      - name: Run spell check
+        run: npm run spell-check

cspell.json

@@ -0,0 +1,36 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "files": ["**/*.{md,mdx,ts,tsx,js,jsx,json}"],
+  "ignorePaths": ["package-lock.json", "yarn.lock", "*.log"],
+  "ignoreRegExpList": ["/```[\\s\\S]*?```/", "/`[^`]*`/"],
+  "allowCompoundWords": true,
+  "dictionaries": ["en", "en-gb", "softwareTerms", "typescript", "node", "npm", "html", "css", "markdown"],
+  "useGitignore": true,
+  "caseSensitive": false,
+  "minWordLength": 3,
+  "words": [
+    "bacalhau",
+    "docusaurus",
+    "mdx",
+    "swizzle",
+    "wrangler",
+    "clsx",
+    "prism",
+    "tsconfig",
+    "ipfs",
+    "expanso",
+    "idx",
+    "boinc",
+    "desci",
+    "GTM",
+    "cuda",
+    "milli",
+    "millicores",
+    "webui",
+    "libp2p",
+    "duckdb",
+    "myvalue",
+    "oom"
+  ]
+}

docs/cli/config/set.md

@@ -65,7 +65,7 @@ node:
 
 ### Set command value validation
 
-#### Example of invalid logging mode valu
+#### Example of invalid logging mode value
 
 ```bash
 bacalhau config set node.loggingmode some-invalid-value

docs/references/developers/running-locally.md

@@ -1,171 +1,103 @@
----
-icon: location-exclamation
-description: How to run a Bacalhau devstack locally
----
+# Running Locally with Devstack
 
-# Running Locally In Devstack
+Bacalhau's devstack provides a quick way to spin up a local testing environment with multiple nodes. This is perfect for development, testing, or simply exploring Bacalhau's capabilities without setting up a full production environment.
 
-You can run a stand-alone Bacalhau network on your computer with the following guide.
+## Prerequisites
 
-The `devstack` command of `bacalhau` will start a 4 node cluster with 3 compute and 1 requester nodes.
+- **Docker Engine**: Must be installed and running
+- **Bacalhau**: Latest version installed
 
-This is useful to kick the tires and/or developing on the codebase. It's also the tool used by some tests.
+## Installation
 
-## Pre-requisites
-
-1. `x86_64` or `ARM64` architecture
-   1. Ubuntu 20.0+ has most often been used for development and testing
-2. [Docker Engine](https://docs.docker.com/get-docker/)
-3. Latest Bacalhau release
-
-## Install Bacalhau
-
-You can install the Bacalhau CLI by running this command in a terminal:
+If you haven't installed Bacalhau yet:
 
 ```bash
 curl -sL https://get.bacalhau.org/install.sh | bash
 ```
 
-See the [installation guide](running-locally.md#install-bacalhau) for more installation options.
+## Starting the Devstack
 
-## Start the cluster
+Starting a local devstack is as simple as:
 
 ```bash
 bacalhau devstack
 ```
 
-This will start a 4 node Bacalhau cluster.
+When initialization completes, you'll see a confirmation message:
 
-Once everything has started up - you will see output like the following:
-
-```bash
+```
 Devstack is ready!
 No. of requester only nodes: 1
 No. of compute only nodes: 3
 No. of hybrid nodes: 0
-To use the devstack, run the following commands in your shell:
-
-export BACALHAU_API_HOST=0.0.0.0
-export BACALHAU_API_PORT=34217
 ```
 
-The message above contains the environment variables you need for a new terminal window. You can paste these into a new terminal so that `bacalhau` will use your local devstack. Execute the [bacalhau node list](/cli/node/list.md) command to see the devstack cluster structure:
+## Using Your Devstack
+
+By default, devstack configures the orchestrator to run on the standard port (1234), so you can immediately use it without additional settings. Open a new terminal window and test your connection:
 
 ```bash
 bacalhau node list
- ID      TYPE       APPROVAL  STATUS     LABELS                                              CPU     MEMORY      DISK         GPU
- node-0  Requester  APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux
-                                         env=devstack id=node-0 name=node-0
- node-1  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux           1.4 /   2.7 GB /    13.1 GB /    0 /
-                                         env=devstack id=node-1 name=node-1                  1.4     2.7 GB      13.1 GB      0
- node-2  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux           1.4 /   2.7 GB /    13.1 GB /    0 /
-                                         env=devstack id=node-2 name=node-2                  1.4     2.7 GB      13.1 GB      0
- node-3  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux           1.4 /   2.7 GB /    13.1 GB /    0 /
-                                         env=devstack id=node-3 name=node-3                  1.4     2.7 GB      13.1 GB      0
 ```
 
-## New Terminal Window
-
-Open an additional terminal window to be used for submitting jobs. Copy and paste environment variables from previous message into this window, e.g.:
+You should see the nodes in your devstack:
 
-```bash
-export BACALHAU_API_HOST=0.0.0.0
-export BACALHAU_API_PORT=34217
+```
+ID      TYPE       APPROVAL  STATUS     LABELS
+node-0  Requester  APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux
+                                        env=devstack id=node-0 name=node-0
+node-1  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux
+                                        env=devstack id=node-1 name=node-1
+node-2  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux
+                                        env=devstack id=node-2 name=node-2
+node-3  Compute    APPROVED  CONNECTED  Architecture=amd64 Operating-System=linux
+                                        env=devstack id=node-3 name=node-3
 ```
 
-You are now ready to submit a job to your local devstack.
-
-## Submit a simple job
+## Running a Simple Job
 
-This will submit a simple job to a single node:
+Submit a simple job to test your devstack:
 
 ```bash
-bacalhau docker run \
---publisher local \
-alpine echo "hello devstack test"
+bacalhau docker run alpine echo "hello devstack"
 ```
 
-This should output something like the following:
-
-```bash
-Job successfully submitted. Job ID: j-5b0ee6dd-6080-4277-99ce-fdf179907b25
-Checking job status... (Enter Ctrl+C to exit at any time, your job will continue running):
+Note that no publisher is needed for basic testing - Bacalhau will handle the job execution without storing results to any external location.
 
- TIME          EXEC. ID    TOPIC            EVENT
- 11:06:24.789              Submission       Job submitted
- 11:06:24.798  e-4fba1f7c  Scheduling       Requested execution on node-1
- 11:06:24.828  e-4fba1f7c  Execution        Running
- 11:06:25.173  e-4fba1f7c  Execution        Completed successfully
+## Advanced Configuration
 
-To get more details about the run, execute:
-	bacalhau job describe j-5b0ee6dd-6080-4277-99ce-fdf179907b25
+Devstack accepts the same configuration options as the `bacalhau serve` command. Here are some useful configuration examples:
 
-To get more details about the run executions, execute:
-	bacalhau job executions j-5b0ee6dd-6080-4277-99ce-fdf179907b25
-To download the results, execute:
-	bacalhau job get j-5b0ee6dd-6080-4277-99ce-fdf179907b25
-
-```
+### Customizing Resource Limits
 
-Use [bacalhau job describe](/cli/job/describe.md) command to view results:
+Limit the CPU and memory allocation for compute nodes:
 
 ```bash
-bacalhau job describe j-5b0ee6dd-6080-4277-99ce-fdf179907b25
+bacalhau devstack -c Compute.AllocatedCapacity.CPU="50%" -c Compute.AllocatedCapacity.Memory="2Gi"
 ```
 
-This should output info about job execution and results:
+### Configuring Job Defaults
 
-```bash
-ID            = j-5b0ee6dd-6080-4277-99ce-fdf179907b25
-Name          = j-5b0ee6dd-6080-4277-99ce-fdf179907b25
-Namespace     = default
-Type          = batch
-State         = Completed
-Count         = 1
-Created Time  = 2024-10-30 10:06:24
-Modified Time = 2024-10-30 10:06:25
-Version       = 0
-
-Summary
-Completed = 1
-
-Job History
- TIME                 TOPIC         EVENT
- 2024-10-30 11:06:24  Submission    Job submitted
- 2024-10-30 11:06:24  State Update  Running
- 2024-10-30 11:06:25  State Update  Completed
-
-Executions
- ID          NODE ID  STATE      DESIRED  REV.  CREATED    MODIFIED   COMMENT
- e-4fba1f7c  node-1   Completed  Stopped  6     6m11s ago  6m11s ago
-
-Execution e-4fba1f7c History
- TIME                 TOPIC       EVENT
- 2024-10-30 11:06:24  Scheduling  Requested execution on node-1
- 2024-10-30 11:06:24  Execution   Running
- 2024-10-30 11:06:25  Execution   Completed successfully
-
-Standard Output
-hello devstack test
-```
-
-Use bacalhau job get command to download job results:
+Set default resource requirements for all batch jobs:
 
 ```bash
-bacalhau job get j-5b0ee6dd-6080-4277-99ce-fdf179907b25
+bacalhau devstack -c JobDefaults.Batch.Task.Resources.CPU="250m" -c JobDefaults.Batch.Task.Resources.Memory="512Mb"
 ```
 
-Results will be downloaded to the current directory. Job results should have the following structure:
+## Accessing the Web UI
+
+The Web UI is enabled by default in devstack for easier monitoring and management. Access it by opening your browser and navigating to:
 
 ```
-j-5b0ee6dd/
-├── exitCode
-├── stderr
-└── stdout
+http://localhost:8438
 ```
 
-If you execute `cat stdout` it should read `hello devstack test`. If you write any files in your job, they will appear in `volumes/output`.
+The Web UI allows you to:
+
+- View all running and completed jobs
+- Inspect node status and resources
+- Monitor job execution details and logs
 
-## Support
+## Stopping Devstack
 
-If you have questions or need support or guidance, please reach out to the [Bacalhau team via Slack](https://bacalhauproject.slack.com/ssb/redirect) (**#general** channel).
+When you're done, simply press `Ctrl+C` in the terminal where devstack is running to shut everything down.

docusaurus.config.ts

@@ -70,6 +70,9 @@ const config: Config = {
         theme: {
           customCss: './src/css/custom.css',
         },
+        googleTagManager: {
+          containerId: 'GTM-M4ZC5QX7',
+        },
       } satisfies Preset.Options,
     ],
   ],
@@ -120,13 +123,6 @@ const config: Config = {
           position: 'left',
           label: 'Community',
         },
-        {
-          href: 'https://github.com/bacalhau-project/bacalhau',
-          className: 'header-github-link',
-          label: 'GitHub',
-          position: 'right',
-          'aria-label': 'GitHub repository',
-        },
         {
           href: 'https://blog.bacalhau.org/',
           label: 'Blog',
@@ -137,6 +133,12 @@ const config: Config = {
           label: 'Enterprise',
           position: 'right',
         },
+        {
+          href: 'https://github.com/bacalhau-project/bacalhau',
+          position: 'right',
+          className: 'header-github-link',
+          'aria-label': 'GitHub repository',
+        },
       ],
     },
     footer: {