Skip to content

Commit

Permalink
site: fix some typos and links
Browse files Browse the repository at this point in the history
  • Loading branch information
bobbobbio committed Jan 15, 2024
1 parent 60424d4 commit 3b28ab5
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 9 deletions.
2 changes: 1 addition & 1 deletion site/src/clustered_job_runner_management/broker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Broker Management
# Broker Configuration

The broker can be configured via CLI, configuration file, or environment
variables. CLI or environment variables override configuration file values.
Expand Down
2 changes: 1 addition & 1 deletion site/src/clustered_job_runner_management/worker.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Worker Management
# Worker Configuration

The worker can be configured via CLI, configuration file, or environment
variables. CLI or environment variables override configuration file values.
Expand Down
6 changes: 3 additions & 3 deletions site/src/install/clustered_job_runner.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Installing Clustered Job Runner
# Installing Clustered Job Runner

This covers setting up the clustered job runner. This is split into two
different parts.
Expand Down Expand Up @@ -78,7 +78,7 @@ will connect to.

The broker can be configured using CLI, environment variables, or configuration
file, for more information see [Broker
Configuration](./clustered_job_runner_management/broker.md)
Configuration](../clustered_job_runner_management/broker.md)

By default it stores its caches in
`<working-directory>/.cache/maelstrom-broker`. For the given set-up this should
Expand Down Expand Up @@ -145,7 +145,7 @@ and it should now show that there is 1 worker.

The worker can be configured using CLI, environment variables, or configuration
file, for more information see [Worker
Configuration](./clustered_job_runner_management/worker.md)
Configuration](../clustered_job_runner_management/worker.md)

By default it stores its caches in
`<working-directory>/.cache/maelstrom-worker`. For the given set-up this should
Expand Down
9 changes: 5 additions & 4 deletions site/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ Maelstrom itself is split up into a few different pieces of software.
the actual job (or test.)
- **The Client**. There are one or many instances of these. This is what
connects to the broker and submits jobs.
- **`cargo-maelstrom`**. This is our cargo test replacement which submits tests
as jobs by acting as a client.
- [`cargo-maelstrom`](./cargo_maelstrom.md). This is our cargo test
replacement which submits tests as jobs by acting as a client.

# What will this book cover?
This guide will attempt to cover the following topics:
Expand All @@ -27,5 +27,6 @@ This guide will attempt to cover the following topics:
Both setting up the clustered job runner and using cargo-maelstrom
- `cargo-maelstrom` configuration. Sometimes extra configuration is needed to make
tests run successfully, this will cover how to do that.
- Clustered job runner management. How clustered job runner works and how to get
insight into the job running process.
- Clustered job runner management. How clustered job runner works, how to
configured it, and how to use the
[web UI](./clustered_job_runner_management/web_ui.md).

0 comments on commit 3b28ab5

Please sign in to comment.