From 9ab58d6f332ab8c4c04f10e6831a5b457c44fed3 Mon Sep 17 00:00:00 2001
From: Jose Diaz-Gonzalez <email@josediazgonzalez.com>
Date: Mon, 5 Sep 2022 21:31:55 -0400
Subject: [PATCH] feat: cleanup output and only ever generate latest docs for a
 version

---
 contrib/build-docs     | 17 +++++++++++------
 contrib/write-mkdocs   |  4 ++--
 docs/_build/entrypoint |  1 +
 3 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/contrib/build-docs b/contrib/build-docs
index 6cd5986ad..5a9689d5e 100755
--- a/contrib/build-docs
+++ b/contrib/build-docs
@@ -9,7 +9,8 @@ main() {
   mkdir -p tmp/docs-build
   cp -r docs docs-main
 
-  git clone https://github.com/dokku/dokku.git tmp/docs-source
+  echo "====> Processing version: latest"
+  git clone -q https://github.com/dokku/dokku.git tmp/docs-source
 
   rm -rf docs/assets
   mkdir -p docs/assets
@@ -25,6 +26,7 @@ main() {
   echo "[]" > tmp/docs-build/versions.json
 
   sed -i.bak "s/outdated/outdated_hidden/g" docs/_overrides/main.html && rm docs/_overrides/main.html.bak
+  echo "----> Generating docs"
   make docs-build
   rm -rf site/_build
   mv site tmp/docs-build/docs
@@ -42,11 +44,13 @@ main() {
         break
       fi
       version="${major}.${minor}.${patch}"
-      echo "version: ${major}.${minor}.${patch}"
+      echo "====> Processing version: ${major}.${minor}.${patch}"
 
       if [[ "$major" -lt 1 ]]; then
-        if [[ "$current_version" != "$version" ]] && [[ "$minor" -lt 28 ]]; then
+        if [[ "$current_version" != "$version" ]]; then
+          echo "      Writing rewrite rule"
           echo "rewrite ^/docs~v$version/(.*)$ /docs~v$current_version/\$1 redirect;" > "tmp/docs-build/nginx.conf.d/$version.conf"
+          echo "      Removing old docs"
           rm -rf "tmp/docs-build/docs~v${version}"
           patch=$((patch - 1))
           continue
@@ -64,8 +68,8 @@ main() {
         continue
       fi
 
-      git -C tmp/docs-source checkout -- .
-      git -C tmp/docs-source checkout "tags/v${version}" -b "v${version}-branch"
+      git -C tmp/docs-source checkout -q -- .
+      git -C tmp/docs-source checkout -q "tags/v${version}" -b "v${version}-branch"
       rm -rf docs
       mv tmp/docs-source/docs docs
 
@@ -77,7 +81,7 @@ main() {
 
       cp -r docs-main/_build docs/_build
       cp -r docs-main/_overrides docs/_overrides
-      git checkout -- mkdocs.yml
+      git checkout -q -- mkdocs.yml
       sed -i.bak "s/site_dir: site/site_dir: docs~v$version/g" mkdocs.yml && rm mkdocs.yml.bak
       if [[ ! -f docs/template.html ]]; then
         if [[ "$patch" -eq 0 ]]; then
@@ -87,6 +91,7 @@ main() {
         continue
       fi
 
+      echo "----> Generating docs"
       if ! make docs-build; then
         continue
       fi
diff --git a/contrib/write-mkdocs b/contrib/write-mkdocs
index ad645f47e..71cea848e 100644
--- a/contrib/write-mkdocs
+++ b/contrib/write-mkdocs
@@ -324,11 +324,11 @@ def update_markdown(src):
 
 
 def main():
-    print("====> Copying mkdocs.yml")
+    print("----> Copying mkdocs.yml")
     print("      Generating navigation")
     generate_nav("/usr/src/source/mkdocs.yml", "/usr/src/app/mkdocs.yml")
 
-    print("====> Copying docs folder")
+    print("----> Copying docs folder")
     update_markdown("/usr/src/source/docs",)
 
     if os.path.exists("/usr/src/app/docs"):
diff --git a/docs/_build/entrypoint b/docs/_build/entrypoint
index 2cf2adf22..891f76432 100755
--- a/docs/_build/entrypoint
+++ b/docs/_build/entrypoint
@@ -14,6 +14,7 @@ main() {
 
   if [[ "$CMD" == "build" ]]; then
     write-mkdocs
+    echo "----> Executing mkdocs build"
     mkdocs build
     site_dir="$(grep site_dir mkdocs.yml | awk '{print $2}')"
     cp -r "/usr/src/app/${site_dir}" "/usr/src/source/${site_dir}"