feat(doc): #940 improve examples

- Improve examples in getting started section - Simplify deploy Signed-off-by: Daniel Salazar <[email protected]>
fluidattacks · Mar 14, 2023 · 896e05c · 896e05c
1 parent e7ae3f9
commit 896e05c
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 18 deletions.
diff --git a/.github/workflows/prod.yml b/.github/workflows/prod.yml
@@ -172,7 +172,6 @@ jobs:
           set-safe-directory: /github/workspace
           args: sh -c "nix-env -if . && m . /docs/deploy prod"
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           CACHIX_AUTH_TOKEN: ${{ secrets.CACHIX_AUTH_TOKEN }}
 
   linux_envVars_example:

diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md
@@ -33,12 +33,25 @@ where:
   If no job is specified,
   Makes displays all available jobs.
 
-You can try:
+Example:
 
-- `$ m github:fluidattacks/makes@main`
-- `$ m github:fluidattacks/makes@main /helloWorld`
-- `$ m gitlab:fluidattacks/makes-example-2@main`
-- `$ m /path/to/local/repo`
+=== "GitHub"
+
+    ```bash
+    m github:fluidattacks/makes@main
+    ```
+
+=== "GitLab"
+
+    ```bash
+    m gitlab:fluidattacks/makes-example-2@main
+    ```
+
+=== "Local"
+
+    ```bash
+    m /path/to/local/repo
+    ```
 
 Makes is powered by [Nix](https://nixos.org).
 This means that it is able to run

diff --git a/makes/docs/deploy/entrypoint.sh b/makes/docs/deploy/entrypoint.sh
@@ -4,24 +4,14 @@ function main {
   local env="${1:-}"
   local domain="makes.fluidattacks.com"
   local cname_path="src/CNAME"
-  local args=(
-    gh-deploy
-    --force
-    --no-history
-  )
 
   : \
     && pushd docs \
     && rm -rf "${cname_path}" \
     && if [ "${env}" == "prod" ]; then
-      : \
-        && echo "${domain}" > "${cname_path}" \
-        && args+=(
-          --remote-name
-          "https://${GITHUB_TOKEN}@github.com/fluidattacks/makes.git"
-        )
+      echo "${domain}" > "${cname_path}"
     fi \
-    && mkdocs "${args[@]}"
+    && mkdocs gh-deploy --force --no-history
 }
 
 main "${@}"