Move the book to doc/book/latest.

maelstrom-software · Jul 11, 2024 · 18234fe · 18234fe
1 parent d1395ef
commit 18234fe
Show file tree

Hide file tree

Showing 10 changed files with 33 additions and 21 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -24,7 +24,7 @@ <h1 id="logo"><a href="index.html" class="image featured first"><img src="images
 					<!-- Nav -->
 						<nav id="nav">
 							<ul>
-								<li><a href="https://maelstrom-software.com/book/">Documentation</a></li>
+								<li><a href="https://maelstrom-software.com/doc/book/latest/">Documentation</a></li>
 								<li><a href="https://maelstrom-software.com/Blog/">Blog</a></li>
 								<li class="icon brands fa-discord"><a href="https://discord.gg/rgeuZz6CfV"><span class="extra"></span>Discord</a></li>
 								<li class="icon brands fa-github"><a href="https://github.com/maelstrom-software/maelstrom"><span class="extra"></span>Github</a></li>
@@ -133,4 +133,4 @@ <h2>Connect with us</h2>
 			<script src="assets/js/main.js"></script>
 
 	</body>
-</html>
+</html>
diff --git a/website/book/index.html b/website/book/index.html
@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Redirecting...</title>
+    <link rel="canonical" href="https://maelstrom-software.com/doc/book/latest/" />
+    <meta charset="utf-8" />
+    <meta http-equiv="refresh" content="0; url=https://maelstrom-software.com/doc/book/latest/" />
+  </head>
+  <body>
+    <p>Redirecting...</p>
+  </body>
+</html>
diff --git a/website/index.html b/website/index.html
@@ -39,7 +39,7 @@ <h2>A clustered, hermetic test runner.
           </header>
           <p>Maelstrom is a test runner for Rust and Pytest, built on top of a general-purpose clustered job engine. </p>
           <ul class="actions">
-            <li><a href="https://maelstrom-software.com/book/" class="button">Learn More</a></li>
+            <li><a href="https://maelstrom-software.com/doc/book/latest/" class="button">Learn More</a></li>
           </ul>
         </section>
 
@@ -62,7 +62,7 @@ <h2>About Maelstrom</h2>
               Maelstrom to run your tests because:
             </p>
 
-            <a href="https://maelstrom-software.com/book/" class="rightimg wrap"><img src="images/Architecture Small.png" alt="" /></a>
+            <a href="https://maelstrom-software.com/doc/book/latest/" class="rightimg wrap"><img src="images/Architecture Small.png" alt="" /></a>
 
             <ul>
               <li>
@@ -116,7 +116,7 @@ <h2>About Maelstrom</h2>
 
             <p>See the book for more information:</p>
             <ul class="actions">
-              <li><a href="https://maelstrom-software.com/book/" class="button">Maelstrom Book</a></li>
+              <li><a href="https://maelstrom-software.com/doc/book/latest/" class="button">Maelstrom Book</a></li>
             </ul>
           </article>
         </div>
@@ -125,7 +125,7 @@ <h2>About Maelstrom</h2>
       <!-- Promo -->
       <div id="promo-wrapper">
         <section id="promo">
-          <a href="https://maelstrom-software.com/book/installation.html" class="image promo"><img src="images/Maelstrom.gif" alt=""></a>
+          <a href="https://maelstrom-software.com/doc/book/latest/installation.html" class="image promo"><img src="images/Maelstrom.gif" alt=""></a>
           <ul class="actions major">
         </section>
       </div>
@@ -162,7 +162,7 @@ <h2>Getting Started</h2>
             </p>
             <p>
               Check out <a
-              href="https://maelstrom-software.com/book/installation.html">the
+              href="https://maelstrom-software.com/doc/book/latest/installation.html">the
               book</a> for more ways to install Maelstrom.
             </p>
 
@@ -191,7 +191,7 @@ <h2>Getting Started</h2>
             <p>
               Then edit the created <tt>cargo-maelstrom.toml</tt> file as
               described <a
-              href="https://maelstrom-software.com/book/cargo-maelstrom/spec.html">
+              href="https://maelstrom-software.com/doc/book/latest/cargo-maelstrom/spec.html">
               in the book.</a>
             </p>
             <p></p>
@@ -246,7 +246,7 @@ <h2>Getting Started</h2>
             </p>
             <p>
               You can install these using <a
-              href="https://maelstrom-software.com/book/installation.html">
+              href="https://maelstrom-software.com/doc/book/latest/installation.html">
               multiple methods</a>, including <tt>cargo-binstall</tt>:
             </p>
             <code>cargo binstall maelstrom-worker maelstrom-broker</code>
@@ -262,7 +262,7 @@ <h2>Getting Started</h2>
             <p></p>
             <p>See the book for more information:</p>
             <ul class="actions">
-              <li><a href="https://maelstrom-software.com/book/" class="button">Maelstrom Book</a></li>
+              <li><a href="https://maelstrom-software.com/doc/book/latest/" class="button">Maelstrom Book</a></li>
             </ul>
           </article>
         </div>