Document scripts

deploy-nginx

@@ -1,5 +1,10 @@
 #!/usr/local/bin/bash
-# Usage: deploy-nginx target
+# Usage: `deploy-nginx $target`
+#
+# Copies nginx configuration files from the repository in the current directory to `$target`, and then reloads nginx.
+#
+# This script is specifically for https://git.fwdekker.com/fwdekker.com/nginx-config.
+
 
 repo_dir="$(pwd)"
 repo_name="$(basename -s .git "$repo_dir")"

deploy-npm

@@ -1,5 +1,10 @@
 #!/usr/local/bin/bash
-# Usage: deploy-npm [--delete-target] target
+# Usage: `deploy-npm [--delete-target] $target`
+#
+# Builds the repository in the current directory with `npm run deploy` and copies the contents of `dist/` into
+# `$target`.
+# If `--delete-target` is set, then `$target` is deleted before copying, except for hidden files and folders.
+
 
 if [ "$1" == "--delete-target" ]; then
     delete_target=true

deploy-npm-versioned

@@ -1,5 +1,12 @@
 #!/usr/local/bin/bash
-# $1 = destination
+# Usage: `deploy-npm-versioned $dst_dir`
+#
+# Builds the repository in the current directory with `npm run deploy` and copies the contents of `dist/` into multiple
+# sub-directories in `$dst_dir`.
+# The sub-directories are named after the version number listed in the `package.json`.
+# If the version is `A.B.C`, then the repository is deployed into sub-directories `A.B.C`, `A.B.x`, and `A.x.x`, where
+# `x` is literal.
+
 
 repo_dir="$(pwd)"
 repo_name="$(basename -s .git "$repo_dir")"

deploy-static

@@ -1,5 +1,9 @@
 #!/usr/local/bin/bash
-# Usage: deploy-static [--delete-target] target
+# Usage: `deploy-static [--delete-target] $target`
+#
+# Takes the repository in the current directory, and copies the contents of `dist/` into `$target`.
+# If `--delete-target` is set, then `$target` is deleted before copying, except for hidden files and folders.
+
 
 if [ "$1" == "--delete-target" ]; then
     delete_target=true