Rework versioning system

Signed-off-by: lucperkins <[email protected]>

docs/.gitignore

@@ -3,7 +3,7 @@ public/
 resources/
 
 # Documentation versions
-content/docs/v*
+generated/docs/v*
 data/releases.yaml
 
 # Node.js assets

docs/Makefile

@@ -1,20 +1,29 @@
+clean:
+	rm -rf public
+
 load-docs:
 	scripts/load-docs.sh
 
 setup:
 	npm install
 
-serve: load-docs
+serve: clean load-docs
 	hugo server \
 		--buildDrafts \
-		--buildFuture
+		--buildFuture \
+		--contentDir generated
 
-production-build: load-docs
-	hugo --minify
+production-build: clean load-docs
+	hugo \
+		--contentDir generated \
+		--ignoreCache \
+		--minify
 
-preview-build: load-docs
+preview-build: clean load-docs
 	hugo \
 		--baseURL $(DEPLOY_PRIME_URL) \
 		--buildDrafts \
 		--buildFuture \
+		--contentDir generated \
+		--ignoreCache \
 		--minify

docs/config.toml

@@ -23,30 +23,7 @@ github = "https://github.com/open-policy-agent/opa"
 sidebar = "/img/logos/opa-stacked-color.png"
 navbar = "/img/logos/opa-icon-white.png"
 
-[[params.home.buttons]]
-url = "/docs/get-started"
-title = "Get started"
-
-[[params.home.buttons]]
-url = "/docs"
-title = "Learn more"
-
 [menu]
-[[menu.main]]
-name = "Documentation"
-url = "/docs"
-weight = 1
-
-[[menu.main]]
-name = "Tutorials"
-url = "/docs/get-started"
-weight = 2
-
-[[menu.main]]
-name = "Playground"
-url = "https://play.openpolicyagent.org"
-weight = 3
-
 [[menu.social]]
 name = "Medium"
 url = "https://twitter.com/openpolicyagent"

docs/layouts/partials/home/banner.html

@@ -1,9 +1,8 @@
 {{ $title       := site.Title }}
 {{ $description := site.Params.description }}
 {{ $tagline     := site.Params.tagline }}
-{{ $buttons     := site.Params.home.buttons }}
-{{ $mainMenu    := site.Menus.main }}
 {{ $socialMenu  := site.Menus.social }}
+{{ $latest      := index site.Data.releases 0 }}
 <header role="banner">
   <nav class="nav--banner" role="navigation">
     <ul class="nav--menu">
@@ -13,13 +12,23 @@
         </a>
       </li>
 
-      {{ range $mainMenu }}
       <li class="nav--menu-item nav--docs">
-        <a href="{{ .URL }}" rel="help">
-          {{ .Name }}
+        <a href="/docs/v{{ $latest }}" rel="help">
+          Documentation
+        </a>
+      </li>
+
+      <li class="nav--menu-item nav--docs">
+        <a href="/docs/v{{ $latest }}/get-started" rel="help">
+          Tutorials
+        </a>
+      </li>
+
+      <li class="nav--menu-item nav--docs">
+        <a href="https://play.openpolicyagent.org" rel="help" target="_blank">
+          Playground
         </a>
       </li>
-      {{ end }}
     </ul>
     <ul class="nav--menu">
       {{ range $socialMenu }}
@@ -47,11 +56,13 @@ <h1 class="headline--title">
       </p>
 
       <p class="headline--nav">
-        {{ range $buttons }}
-        <a id="headline--{{ urlize .title }}" href="{{ .url }}" rel="help">
-          {{ .title }}
+        <a id="headline--get-started" href="/docs/v{{ $latest }}/get-started" rel="help">
+          Get started
+        </a>
+
+        <a id="headline--learn-more" href="/docs/v{{ $latest }}" rel="help">
+            Learn more
         </a>
-        {{ end }}
       </p>
     </div>
 

docs/scripts/load-docs.sh

@@ -16,11 +16,13 @@ rm -f ${RELEASES_YAML_FILE}
 rm -rf ${ROOT_DIR}/docs/content/docs/v*
 
 for release in ${RELEASES}; do
+    version_docs_dir=${ROOT_DIR}/docs/generated/docs/v${release}
+    mkdir -p ${version_docs_dir}
+
     echo "Copying the documentation for release v${release}"
     echo "- ${release}" >> ${RELEASES_YAML_FILE}
 
-    mkdir ${ROOT_DIR}/docs/content/docs/v${LATEST}
-    cp ${ROOT_DIR}/docs/content/docs/* ${ROOT_DIR}/docs/content/docs/v${LATEST}/
+    cp ${ROOT_DIR}/docs/content/docs/* ${version_docs_dir}/
 done
 
 git checkout ${CURRENT_BRANCH}