summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOwen Jacobson <owen@grimoire.ca>2022-02-26 13:13:21 -0500
committerOwen Jacobson <owen@grimoire.ca>2022-02-26 13:20:38 -0500
commit9e92498533eeba0033f5096421b159eb47802bf8 (patch)
tree823ba319f91dba2994997f147ec2e51a1860eb83
parent84bae43e6f5d7a8a47805cd9fad2d7757a147f46 (diff)
Start using the tools/ convention for standard processes
-rw-r--r--README.md12
-rwxr-xr-xtools/build9
-rwxr-xr-xtools/publish9
3 files changed, 20 insertions, 10 deletions
diff --git a/README.md b/README.md
index 2b5ea2d..4aa3071 100644
--- a/README.md
+++ b/README.md
@@ -11,11 +11,7 @@ You will need:
## Building
-To prepare this site for deployment, run mkdocs from the project's root directory:
-
-```bash
-mkdocs build
-```
+To prepare this site for deployment, run mkdocs from the project's root directory, use the included `tools/build` script.
The resulting files will be placed in `site` under the project's root directory, replacing any files already present.
@@ -29,8 +25,4 @@ This will automatically rebuild the site every time the files in `docs` change,
## Publishing
-Once the site is built, it can be published to s3:
-
-```bash
-aws s3 sync --delete site/ s3://grimoire.ca/
-```
+Once the site is built, it can be published to s3 using `tools/publish`.
diff --git a/tools/build b/tools/build
new file mode 100755
index 0000000..5e25d51
--- /dev/null
+++ b/tools/build
@@ -0,0 +1,9 @@
+#!/bin/bash -e
+
+cd "$(dirname "$0")/.."
+
+## tools/build
+##
+## Converts the content in docs/ into a deployable website in site/
+
+exec mkdocs build
diff --git a/tools/publish b/tools/publish
new file mode 100755
index 0000000..ee8aa63
--- /dev/null
+++ b/tools/publish
@@ -0,0 +1,9 @@
+#!/bin/bash -e
+
+cd "$(dirname "$0")/.."
+
+## tools/publish
+##
+## Publishes site/ to the S3 bucket hosting grimoire.ca
+
+exec aws s3 sync --delete site/ s3://grimoire.ca/