Split documentation pages and site

futurice · Sep 21, 2023 · 774e0e0 · 774e0e0
1 parent 6e0d0c3
commit 774e0e0
Show file tree

Hide file tree

Showing 22 changed files with 31 additions and 33 deletions.
diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -21,29 +21,34 @@ jobs:
         with:
           go-version: "1.21"
 
+      - name: Setup Golang caches
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-golang-${{ hashFiles('go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-golang-
+
       - uses: actions/setup-node@v3
         with:
           node-version: 18
           cache: npm
-          cache-dependency-path: docs/package-lock.json
+          cache-dependency-path: docs/site/package-lock.json
 
       - uses: arduino/setup-task@v1
         with:
           version: 3.x
           repo-token: ${{ secrets.GITHUB_TOKEN }} # https://github.com/arduino/setup-task#repo-token
 
       - name: Install dependencies
-        working-directory: docs
+        working-directory: docs/site
         run: npm ci
 
-      - name: Generate dynamic docs
-        run: task docs:gen
-
       - name: Build website
         run: task docs:build
 
-      # Popular action to deploy to GitHub Pages:
-      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:

diff --git a/Taskfile.yml b/Taskfile.yml
@@ -2,17 +2,13 @@ version: "3"
 
 includes:
   docs:
-    taskfile: ./docs
-    dir: ./docs
+    taskfile: ./docs/site
+    dir: ./docs/site
 
 vars:
   ENTRYPOINT: ./cmd/jalapeno # Path to main package
 
 tasks:
-  docs:gen:
-    desc: Generate CLI documentation
-    cmds:
-      - go run cmd/docs/main.go ./docs/docs/api.md
   mod:
     desc: Downloads and tidy Go modules
     cmds:

diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,20 +1,9 @@
 # Dependencies
-/node_modules
+node_modules
 
 # Production
-/build
+build
 
 # Generated files
 .docusaurus
 .cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
diff --git a/docs/pages b/docs/pages
@@ -0,0 +1 @@
+site/docs/
diff --git a/docs/README.md → docs/site/README.md b/docs/README.md → docs/site/README.md
diff --git a/docs/Taskfile.yml → docs/site/Taskfile.yml b/docs/Taskfile.yml → docs/site/Taskfile.yml
@@ -1,29 +1,36 @@
 version: "3"
 
+vars:
+  BUILD_DIR: "../build"
+
 tasks:
   setup:
     desc: Setup Docusaurus locally
     cmds:
       - npm install
 
+  gen:
+    desc: Generate CLI documentation
+    dir: "{{.ROOT_DIR}}"
+    cmds:
+      - go run cmd/docs/main.go ./docs/pages/api.md
+
   start:
     desc: Start website
+    aliases: [run]
     vars:
       PORT: '{{default "3001" .PORT}}'
+    deps: [gen]
     cmds:
       - npx docusaurus start --no-open --port={{.PORT}}
 
   build:
     desc: Build website
+    deps: [gen]
     cmds:
-      - npx docusaurus build
+      - npx docusaurus build --out-dir {{.BUILD_DIR}}
 
   clean:
     desc: Clean temp directories
     cmds:
-      - rm -rf ./build
-
-  deploy:
-    desc: Build and deploy Docusaurus. Requires GIT_USER and GIT_PASS envs to be previous set
-    cmds:
-      - npx docusaurus deploy
+      - rm -rf {{.BUILD_DIR}}
diff --git a/docs/babel.config.js → docs/site/babel.config.js b/docs/babel.config.js → docs/site/babel.config.js
diff --git a/docs/docs/api.md → docs/site/docs/api.md b/docs/docs/api.md → docs/site/docs/api.md
diff --git a/docs/docs/contributing.md → docs/site/docs/contributing.md b/docs/docs/contributing.md → docs/site/docs/contributing.md
diff --git a/docs/docs/installation.md → docs/site/docs/installation.md b/docs/docs/installation.md → docs/site/docs/installation.md
diff --git a/docs/docs/intro.md → docs/site/docs/intro.md b/docs/docs/intro.md → docs/site/docs/intro.md
diff --git a/docs/docs/usage.md → docs/site/docs/usage.md b/docs/docs/usage.md → docs/site/docs/usage.md
diff --git a/docs/docusaurus.config.js → docs/site/docusaurus.config.js b/docs/docusaurus.config.js → docs/site/docusaurus.config.js
diff --git a/docs/package-lock.json → docs/site/package-lock.json b/docs/package-lock.json → docs/site/package-lock.json
diff --git a/docs/package.json → docs/site/package.json b/docs/package.json → docs/site/package.json
diff --git a/docs/sidebars.js → docs/site/sidebars.js b/docs/sidebars.js → docs/site/sidebars.js
diff --git a/docs/src/components/.gitkeep → docs/site/src/components/.gitkeep b/docs/src/components/.gitkeep → docs/site/src/components/.gitkeep
diff --git a/docs/src/css/custom.css → docs/site/src/css/custom.css b/docs/src/css/custom.css → docs/site/src/css/custom.css
diff --git a/docs/src/pages/.gitkeep → docs/site/src/pages/.gitkeep b/docs/src/pages/.gitkeep → docs/site/src/pages/.gitkeep
diff --git a/docs/static/.nojekyll → docs/site/static/.nojekyll b/docs/static/.nojekyll → docs/site/static/.nojekyll
diff --git a/docs/static/img/logo.png → docs/site/static/img/logo.png b/docs/static/img/logo.png → docs/site/static/img/logo.png
diff --git a/docs/static/img/logo.svg → docs/site/static/img/logo.svg b/docs/static/img/logo.svg → docs/site/static/img/logo.svg