Merge pull request #1033 from dsalaza4/main

feat(doc): #940 custom domain

.github/workflows/prod.yml

@@ -167,10 +167,10 @@ jobs:
     steps:
       - uses: actions/checkout@2541b1294d2704b0964813337f33b291d3f8596b
       - uses: docker://docker.io/nixos/nix@sha256:1d13ae379fb8caf3f859c5ce7ec6002643d60cf8b7b6147b949cc34880c93bac
-        name: /docs/gh-deploy
+        name: /docs/deploy
         with:
           set-safe-directory: /github/workspace
-          args: sh -c "nix-env -if . && m . /docs gh-deploy --force --no-history"
+          args: sh -c "nix-env -if . && m . /docs/deploy prod"
         env:
           CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
 

README.md

@@ -51,11 +51,11 @@ It is
 
 ## Installation
 
-[Installation](https://fluidattacks.github.io/makes/#installation)
+[Installation](https://makes.fluidattacks.com/getting-started/#installation)
 
 ## Documentation
 
-See https://fluidattacks.github.io/makes/
+See https://makes.fluidattacks.com
 
 ## Issues
 

docs/.gitignore

@@ -1 +1,2 @@
 /site
+/src/CNAME

docs/mkdocs.yaml

@@ -1,5 +1,5 @@
 site_name: Makes
-site_url: https://fluidattacks.github.io/makes/
+site_url: https://makes.fluidattacks.com/
 site_description: Documentation for Makes
 site_author: Fluid Attacks
 repo_url: https://github.com/fluidattacks/makes

makes/docs/deploy/entrypoint.sh

@@ -0,0 +1,17 @@
+# shellcheck shell=bash
+
+function main {
+  local env="${1:-}"
+  local domain="makes.fluidattacks.com"
+  local cname_path="src/CNAME"
+
+  : \
+    && pushd docs \
+    && rm -rf "${cname_path}" \
+    && if [ "${env}" == "prod" ]; then
+      echo "${domain}" > "${cname_path}"
+    fi \
+    && mkdocs gh-deploy --force --no-history
+}
+
+main "${@}"

makes/docs/deploy/main.nix

@@ -0,0 +1,10 @@
+{
+  makeScript,
+  outputs,
+  ...
+}:
+makeScript {
+  name = "docs-deploy";
+  entrypoint = ./entrypoint.sh;
+  searchPaths.source = [outputs."/docs/runtime"];
+}

makes/docs/entrypoint.sh → makes/docs/dev/entrypoint.sh

@@ -3,7 +3,7 @@
 function main {
   : \
     && pushd docs \
-    && mkdocs "${@}"
+    && mkdocs serve
 }
 
 main "${@}"

makes/docs/main.nix → makes/docs/dev/main.nix

@@ -4,7 +4,7 @@
   ...
 }:
 makeScript {
-  name = "docs";
+  name = "docs-dev";
   entrypoint = ./entrypoint.sh;
   searchPaths.source = [outputs."/docs/runtime"];
 }