[Docs] Fix docs and adjust CI to catch bad links (#467)

pokt-network · Apr 8, 2024 · 2e17beb · 2e17beb
1 parent 38a9658
commit 2e17beb
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 13 deletions.
diff --git a/.github/workflows/upload-pages-artifact.yml b/.github/workflows/upload-pages-artifact.yml
@@ -1,33 +1,60 @@
-# Based off of https://github.com/LayZeeDK/github-pages-docusaurus
-name: Deploy docusaurus docs to GitHub pages
+name: Check and Deploy docusaurus
 
 on:
   push:
     branches: ["main"]
+  pull_request:
+    branches: ["main"]
+    paths:
+      - "docusaurus/**"
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
   cancel-in-progress: true
 
 jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: "yarn"
+          cache-dependency-path: docusaurus/yarn.lock
+
+      - name: Install dependencies
+        run: |
+          cd docusaurus
+          yarn install
+
+      - name: Build
+        run: |
+          cd docusaurus
+          yarn build
+
   deploy:
-    permissions:
-      id-token: write
-      pages: write
+    needs: validate
+    if: github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      pages: write
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      # 👇 Build steps
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
           node-version: 18
-          cache: 'yarn'
+          cache: "yarn"
           cache-dependency-path: docusaurus/yarn.lock
 
       - name: Install dependencies
@@ -40,8 +67,6 @@ jobs:
           cd docusaurus
           yarn build
 
-      # 👆 Build steps
-
       - name: Setup Pages
         uses: actions/configure-pages@v4
         with:
@@ -50,10 +75,8 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
-          # 👇 Specify build output path relative to the subdirectory
           path: docusaurus/build
 
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
-
diff --git a/docusaurus/docs/developer_guide/quickstart.md b/docusaurus/docs/developer_guide/quickstart.md
@@ -43,7 +43,7 @@ Install the following dependencies:
 6. [Tilt](https://docs.tilt.dev/install.html) - k8s local development tool & environment manager
 
 :::note
-You might already have these installed if you've followed the [localnet instructions](./internal_infrastructure/localnet.md).
+You might already have these installed if you've followed the [localnet instructions](../internal_infrastructure/localnet.md).
 :::
 
 ## Launch LocalNet