From 18234fe3f355c235ce27f8083cd0431224b4a59e Mon Sep 17 00:00:00 2001 From: Neal Fachan Date: Thu, 11 Jul 2024 12:27:18 -0700 Subject: [PATCH] Move the book to doc/book/latest. --- .github/workflows/ci.yml | 2 +- Cargo.toml | 2 +- README.md | 10 +++++----- crates/cargo-maelstrom/README.md | 2 +- crates/maelstrom-go-test/README.md | 2 +- crates/maelstrom-pytest/README.md | 2 +- crates/maelstrom-run/README.md | 2 +- website/Blog.html | 4 ++-- website/book/index.html | 12 ++++++++++++ website/index.html | 16 ++++++++-------- 10 files changed, 33 insertions(+), 21 deletions(-) create mode 100644 website/book/index.html diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 90109cde..fccc5494 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -80,7 +80,7 @@ jobs: echo `pwd`/mdbook >> $GITHUB_PATH - name: Build Documentation run: | - mdbook build --dest-dir ../../website/book doc/book + mdbook build --dest-dir ../../website/doc/book/latest doc/book - name: Set up Pages uses: actions/configure-pages@v4 - name: Upload Artifact diff --git a/Cargo.toml b/Cargo.toml index b08ae41c..8575187a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -9,7 +9,7 @@ panic = "abort" panic = "abort" [workspace.package] -documentation = "https://maelstrom-software.com/book/" +documentation = "https://maelstrom-software.com/doc/book/latest/" edition = "2021" homepage = "https://maelstrom-software.com" license = "MIT OR Apache-2.0" diff --git a/README.md b/README.md index d041df4e..ccc84d96 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ bindings for programmatic access and control. The project is currently Linux-only (x86 and ARM), as it relies on namespaces to implement containers. -See the [book](https://maelstrom-software.com/book/) for more information. +See the [book](https://maelstrom-software.com/doc/book/latest/) for more information. # Getting Started @@ -59,7 +59,7 @@ This will install a pre-built binary from the [github releases page](https://git If you don't have `cargo-binstall`, you can download the binaries manually. -Check out the [book](https://maelstrom-software.com/book/installation.html) for more ways to get Maelstrom. +Check out the [book](https://maelstrom-software.com/doc/book/latest/installation.html) for more ways to get Maelstrom. ## Running `cargo-maelstrom` @@ -81,7 +81,7 @@ do this, run: cargo maelstrom --init ``` -Then edit the created `cargo-maelstrom.toml` file as described in the [book](https://maelstrom-software.com/book/cargo-maelstrom/spec.html). +Then edit the created `cargo-maelstrom.toml` file as described in the [book](https://maelstrom-software.com/doc/book/latest/cargo-maelstrom/spec.html). ## Running `maelstrom-pytest` @@ -135,7 +135,7 @@ You will need to run one copy of the broker (`maelstrom-broker`) somewhere, and one copy of the worker (`maelstrom-worker`) on each node of the cluster. You can install these using [multiple -methods](https://maelstrom-software.com/book/installation.html), +methods](https://maelstrom-software.com/doc/book/latest/installation.html), including `cargo-binstall`: ```bash @@ -163,7 +163,7 @@ maelstrom-pytest --broker=broker-host:1234 # Learn More -Find our complete documentation in the [book](https://maelstrom-software.com/book/). +Find our complete documentation in the [book](https://maelstrom-software.com/doc/book/latest/). # Licensing diff --git a/crates/cargo-maelstrom/README.md b/crates/cargo-maelstrom/README.md index e6a5efa7..b1e53036 100644 --- a/crates/cargo-maelstrom/README.md +++ b/crates/cargo-maelstrom/README.md @@ -2,7 +2,7 @@ This cargo extension runs Rust tests on a Maelstrom cluster. -See the [Maelstrom book](https://maelstrom-software.com/book/) for +See the [Maelstrom book](https://maelstrom-software.com/doc/book/latest/) for more information on how to use `cargo-maelstrom`. More information on the Maelstrom project can be found on the [GitHub diff --git a/crates/maelstrom-go-test/README.md b/crates/maelstrom-go-test/README.md index 60d33b49..db08f05f 100644 --- a/crates/maelstrom-go-test/README.md +++ b/crates/maelstrom-go-test/README.md @@ -2,7 +2,7 @@ This program runs go test on a Maelstrom Cluster -See the [Maelstrom book](https://maelstrom-software.com/book/) for +See the [Maelstrom book](https://maelstrom-software.com/doc/book/latest/) for more information on how to use `maestrom-go-test`. More information on the Maelstrom project can be found on the [GitHub diff --git a/crates/maelstrom-pytest/README.md b/crates/maelstrom-pytest/README.md index cc8cb7fd..20e9cd73 100644 --- a/crates/maelstrom-pytest/README.md +++ b/crates/maelstrom-pytest/README.md @@ -2,7 +2,7 @@ This binary runs Python tests via [pytest](https://pytest.org) on a Maelstrom cluster. -See the [Maelstrom book](https://maelstrom-software.com/book/) for +See the [Maelstrom book](https://maelstrom-software.com/doc/book/latest/) for more information on how to use `maelstrom-pytest`. More information on the Maelstrom project can be found on the [GitHub diff --git a/crates/maelstrom-run/README.md b/crates/maelstrom-run/README.md index 175ddf08..c3121f29 100644 --- a/crates/maelstrom-run/README.md +++ b/crates/maelstrom-run/README.md @@ -2,7 +2,7 @@ This program can be used to submit arbitrary jobs to a Maelstrom cluster. -See the [Maelstrom book](https://maelstrom-software.com/book/) for +See the [Maelstrom book](https://maelstrom-software.com/doc/book/latest/) for more information on how to use the program. More information on the Maelstrom project can be found on the [GitHub diff --git a/website/Blog.html b/website/Blog.html index 10d9563a..6abab522 100644 --- a/website/Blog.html +++ b/website/Blog.html @@ -24,7 +24,7 @@