diff --git a/book/_redirects b/book/_redirects new file mode 100644 index 00000000..3db10678 --- /dev/null +++ b/book/_redirects @@ -0,0 +1,2 @@ +# Redirects from what the browser requests to what we serve +/ /salsa2022 \ No newline at end of file diff --git a/book/netlify.sh b/book/netlify.sh index aad6c9d7..7f6c3f26 100755 --- a/book/netlify.sh +++ b/book/netlify.sh @@ -13,4 +13,34 @@ curl -L https://github.com/badboy/mdbook-mermaid/releases/download/v$MDBOOK_MERM curl -L https://github.com/Michael-F-Bryan/mdbook-linkcheck/releases/download/v$MDBOOK_LINKCHECK_VERSION/mdbook-linkcheck.v$MDBOOK_LINKCHECK_VERSION.x86_64-unknown-linux-gnu.zip -O unzip mdbook-linkcheck.v$MDBOOK_LINKCHECK_VERSION.x86_64-unknown-linux-gnu.zip -d ~/.cargo/bin chmod +x ~/.cargo/bin/mdbook-linkcheck -mdbook build \ No newline at end of file + +# ====================================================================== +# The following script automates the deployment of both the latest and a +# specified older version of the 'salsa' documentation using mdbook + +# Store the current branch or commit +original_branch=$(git rev-parse --abbrev-ref HEAD) +if [ "$original_branch" == "HEAD" ]; then + original_branch=$(git rev-parse HEAD) +fi + +mkdir -p versions # Create a root directory for all versions + +# Declare an associative array to map commits to custom version directory names +declare -A commit_to_version=( ["$original_branch"]="salsa2022" ["754eea8b5f8a31b1100ba313d59e41260b494225"]="salsa" ) + +# Loop over the keys (commit hashes or branch names) in the associative array +for commit in "${!commit_to_version[@]}"; do + git checkout $commit + mdbook build + version_dir="versions/${commit_to_version[$commit]}" + mkdir -p $version_dir + mv book/html/* $version_dir + rm -rf book +done + +# Return to the original branch or commit +git checkout $original_branch + +# Copy _redirects to the root directory +cp _redirects versions diff --git a/book/src/caveat.md b/book/src/caveat.md index bc3a4607..156de317 100644 --- a/book/src/caveat.md +++ b/book/src/caveat.md @@ -1,3 +1,5 @@ > ⚠️ **IN-PROGRESS VERSION OF SALSA.** ⚠️ > > This page describes the unreleased "Salsa 2022" version, which is a major departure from older versions of salsa. The code here works but is only available on github and from the `salsa-2022` crate. +> +> If you are looking for the older version of salsa, simply visit [this link](https://salsa-rs.netlify.app/salsa)