From 19b7ff92e023f6b5f0b9290a092b5099143ad932 Mon Sep 17 00:00:00 2001
From: SG <mero.mero.guero@gmail.com>
Date: Thu, 6 Oct 2022 07:09:57 -0600
Subject: [PATCH] Tweaks to building documentation

---
 .dockerignore                  |  1 +
 Dockerfiles/nginx.Dockerfile   |  2 +-
 scripts/documentation_build.sh | 28 +++++++++++++++++++++++++++-
 3 files changed, 29 insertions(+), 2 deletions(-)

diff --git a/.dockerignore b/.dockerignore
index 264ef074b..ed6726075 100644
--- a/.dockerignore
+++ b/.dockerignore
@@ -24,6 +24,7 @@ arkime-logs
 arkime-raw
 nginx/nginx_ldap.conf
 pcap
+_site
 scripts
 !scripts/malcolm_common.py
 zeek-logs
diff --git a/Dockerfiles/nginx.Dockerfile b/Dockerfiles/nginx.Dockerfile
index e6cc685d5..8cf624182 100644
--- a/Dockerfiles/nginx.Dockerfile
+++ b/Dockerfiles/nginx.Dockerfile
@@ -14,7 +14,7 @@ FROM ghcr.io/mmguero-dev/jekyll:latest as docbuild
 ARG VCS_REVISION
 ENV VCS_REVISION $VCS_REVISION
 
-ADD README.md _includes _layouts _site _config.yml Gemfile docs /site/
+ADD README.md _includes _layouts _config.yml Gemfile docs /site/
 
 WORKDIR /site
 
diff --git a/scripts/documentation_build.sh b/scripts/documentation_build.sh
index 4bf7ab668..285b6a9cf 100755
--- a/scripts/documentation_build.sh
+++ b/scripts/documentation_build.sh
@@ -22,6 +22,7 @@ LOG_BASE_DIR=$(pwd)
 while getopts 'v' OPTION; do
   case "$OPTION" in
     v)
+      set -x
       VERBOSE_FLAG="-v"
       ;;
 
@@ -59,6 +60,18 @@ else
   exit 1
 fi
 
+################################################################################
+# cleanup temporary directory, if any
+WORKDIR="$(mktemp -d -t malcolm-docs-XXXXXX)"
+
+function _cleanup {
+  if [[ -d "$WORKDIR" ]] && ! rm -rf "$WORKDIR"; then
+   echo "Failed to remove temporary directory '$WORKDIR'" >&2
+  fi
+}
+
+trap "_cleanup" EXIT
+
 # force-navigate to Malcolm base directory (parent of scripts/ directory)
 RUN_PATH="$(pwd)"
 SCRIPT_PATH="$($DIRNAME $($REALPATH -e "${BASH_SOURCE[0]}"))"
@@ -67,9 +80,22 @@ pushd "$SCRIPT_PATH/.." >/dev/null 2>&1
 # clean up old documentation builds
 [[ -d ./_site/ ]] && rm -rf ./_site/
 
+# copy just what's needed for documentation into temporary working directory and build there
+cp $VERBOSE_FLAG -r README.md _includes _layouts _config.yml Gemfile docs "$WORKDIR"
+pushd "$WORKDIR" >/dev/null 2>&1
+
 # run jekyll docker container to generate HTML version of the documentation
-$DOCKER_BIN run --rm -v "$(pwd)":/site --entrypoint="docker-entrypoint.sh" ghcr.io/mmguero-dev/jekyll bundle exec jekyll build
+$DOCKER_BIN run --rm -v "$(pwd)":/site --entrypoint="docker-entrypoint.sh" ghcr.io/mmguero-dev/jekyll:latest bundle exec jekyll build
+
+# clean up some files no longer needed
+find ./_site/ -type f -name "*.md" -delete
+
 # TODO: can we get this to run mapping UID so it doesn't have to be sudo'd?
 $SUDO_CMD chown -R $(id -u):$(id -g) ./_site/
 
+popd >/dev/null 2>&1
+
+# copy built documentation from work directory
+cp $VERBOSE_FLAG -r "$WORKDIR"/_site/ ./
+
 popd >/dev/null 2>&1
\ No newline at end of file