TE-11137: UI revamp — Mintlify-style navbar, API Reference, FAQ, Ask AI, sidebar/TOC

.github/workflows/pr.yml

@@ -31,13 +31,20 @@ jobs:
           with:
             node-version: '16.14.0'
             cache: 'npm'
+
+        - name: 'Create env file'
+        run: |
+          touch .env
+          echo "HOST=${{ secrets.TYPESENSE_HOST }}" >> .env
+          echo "API=${{ secrets.PUBLIC_APY_TYPESENSE }}" >> .env
+
         - name: Docusaurus Webpack cache
           uses: actions/cache@v3
           with:
             path: node_modules/.cache
             key: ${{ runner.os }}-webpack-cache
         - name: Install dependencies
-          run: npm install
+          run: npm install --legacy-peer-deps
         - name: Build the Docusaurus site
           env:
             NODE_OPTIONS: "--max-old-space-size=8192"

.github/workflows/prod-deployment.yml

@@ -0,0 +1,72 @@
+name: 'Deployment (Prod - New Bucket)'
+on:
+  #push:
+  #  branches:
+  #    - 'prod'
+  workflow_dispatch:
+
+jobs:
+  Docusaurus:
+    name: 'Deployment'
+    runs-on: ubuntu-latest
+    environment: prod
+
+    steps:
+
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Find and Replace
+        uses: jacobtomlinson/gha-find-replace@master
+        with:
+          find: ${{ secrets.CDN_URL }}
+          replace: ${{ secrets.PROD_WEBSITE_URL }}
+
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Find and Replace
+        uses: jacobtomlinson/gha-find-replace@master
+        with:
+          find: "indexName: '${{ secrets.STAGE_INDEX }}',"
+          replace: "indexName: '${{ secrets.PROD_INDEX }}',"
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v1
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_MKT }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_MKT }}
+          aws-region: us-east-1
+
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo "HOST=${{ secrets.TYPESENSE_HOST }}" >> .env
+          echo "API=${{ secrets.PUBLIC_APY_TYPESENSE }}" >> .env
+
+      - name: Use Node.js 20.10.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.10.x
+
+      - run: npm install --legacy-peer-deps && npm run build
+        env:
+          CI: false
+
+      - name: Copy files to S3 with the AWS CLI
+        run: |
+          cp -R assets/ build/
+          cd build/
+          aws s3 sync . s3://lambdatest-prod-docs/support/ --exclude 'robots.txt' --delete
+
+      - name: Invalidate Cloudfront
+        run : |
+          aws cloudfront create-invalidation --distribution-id EEMGB6PM4ZZ7A  --paths "/support/*"
+          sleep 90
+
+      - name: Cloudflare Invalidation
+        run: |
+          curl -X POST "https://api.cloudflare.com/client/v4/zones/${{ secrets.CLOUDFLARE_ZONE_ID }}/purge_cache" -H "X-Auth-Email: ${{ secrets.CF_ACCOUNT }}" -H "X-Auth-Key: ${{ secrets.CF_API_SECRET }}" -H "Content-Type: application/json" --data '{"hosts":["${{ secrets.PROD_WEBSITE_URL }}"] }'
+          sleep 60

.github/workflows/testmu-prod-deployment.yml

@@ -0,0 +1,65 @@
+name: 'Deployment (Prod - New Bucket)'
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  Docusaurus:
+    name: 'Deployment'
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+          fetch-depth: 0
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_MKT }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_MKT }}
+          aws-region: us-east-1
+
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo "HOST=${{ secrets.TYPESENSE_HOST }}" >> .env
+          echo "API=${{ secrets.PUBLIC_APY_TYPESENSE }}" >> .env
+
+
+
+      - name: Use Node.js 20.10.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.10.x
+
+      - name: Install dependencies and build
+        run: npm install --legacy-peer-deps && npm run build
+        env:
+          CI: false
+
+      - name: Copy files to S3 with AWS CLI
+        run: |
+          cp -R assets/ build/
+          cd build/
+          aws s3 sync . s3://lambdatest-prod-support-docs-testmu/support/ --exclude 'robots.txt' --delete
+
+      - name: Invalidate CloudFront
+        run: |
+          aws cloudfront create-invalidation \
+            --distribution-id E1H12B601LAQRA \
+            --paths "/support/*"
+          sleep 90
+
+      - name: Cloudflare Invalidation
+        run: |
+          curl -X POST "https://api.cloudflare.com/client/v4/zones/${{ secrets.CLOUDFLARE_ZONE_ID }}/purge_cache" \
+            -H "X-Auth-Email: ${{ secrets.CF_ACCOUNT }}" \
+            -H "X-Auth-Key: ${{ secrets.CF_API_SECRET }}" \
+            -H "Content-Type: application/json" \
+            --data '{"hosts":["${{ secrets.PROD_WEBSITE_URL }}"] }'
+          sleep 60

.github/workflows/testmu-stage-deployment.yml

@@ -0,0 +1,65 @@
+name: 'Deployment (Stage - New Bucket)'
+
+on:
+  push:
+    branches:
+      - stage
+
+jobs:
+  Docusaurus:
+    name: 'Deployment'
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: stage
+          fetch-depth: 0
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID_MKT }}
+          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY_MKT }}
+          aws-region: us-east-1
+
+      - name: 'Create env file'
+        run: |
+          touch .env
+          echo "HOST=${{ secrets.TYPESENSE_HOST }}" >> .env
+          echo "API=${{ secrets.PUBLIC_APY_TYPESENSE }}" >> .env
+
+
+
+      - name: Use Node.js 20.10.x
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.10.x
+
+      - name: Install dependencies and build
+        run: npm install --legacy-peer-deps && npm run build
+        env:
+          CI: false
+
+      - name: Copy files to S3 with AWS CLI
+        run: |
+          cp -R assets/ build/
+          cd build/
+          aws s3 sync . s3://lambdatest-stage-support-docs-testmu/support/ --exclude 'robots.txt' --delete
+
+      - name: Invalidate CloudFront
+        run: |
+          aws cloudfront create-invalidation \
+            --distribution-id EEMGB6PM4ZZ7A \
+            --paths "/support/*"
+          sleep 90
+
+      - name: Cloudflare Invalidation
+        run: |
+          curl -X POST "https://api.cloudflare.com/client/v4/zones/${{ secrets.CLOUDFLARE_ZONE_ID }}/purge_cache" \
+            -H "X-Auth-Email: ${{ secrets.CF_ACCOUNT }}" \
+            -H "X-Auth-Key: ${{ secrets.CF_API_SECRET }}" \
+            -H "Content-Type: application/json" \
+            --data '{"hosts":["${{ secrets.PROD_WEBSITE_URL }}"] }'
+          sleep 60

.github/workflows/typesense-crawler-prod.yml

@@ -1,25 +1,24 @@
 name: Typesense crawler for prod
 
 on:
+    push:
     pull_request:
-      branches:
-        - main
-    merge_group:
-
+        branches:
+            - main
 
 jobs:
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-    environment: main
+    # environment: prod
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3   # You MUST checkout your repository first!
 
       - name: Run DocSearch Scraper
-        env:
-            API_KEY: ${{ secrets.TYPESENSE_API_KEY }}
-            HOST: ${{ secrets.TYPESENSE_HOST }}
+        # env:
+        #     API_KEY: ${{ secrets.TYPESENSE_API_KEY }}
+        #     HOST: ${{ secrets.TYPESENSE_HOST }}
         uses: celsiusnarhwal/typesense-scraper@v2
         with:
           # The secret containing your Typesense API key. Required.

.github/workflows/typesense-crawler-stage.yml

@@ -1,24 +1,25 @@
 name: Typesense crawler for stage
 
 on:
-    push:
     pull_request:
-        branches:
-            - stage
+      branches:
+        - stage
+    merge_group:
+
 
 jobs:
   build:
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
-    # environment: stage
+    environment: stage
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3   # You MUST checkout your repository first!
 
       - name: Run DocSearch Scraper
-        # env:
-        #     API_KEY: ${{ secrets.TYPESENSE_API_KEY }}
-        #     HOST: ${{ secrets.TYPESENSE_HOST }}
+        env:
+            API_KEY: ${{ secrets.TYPESENSE_API_KEY }}
+            HOST: ${{ secrets.TYPESENSE_HOST }}
         uses: celsiusnarhwal/typesense-scraper@v2
         with:
           # The secret containing your Typesense API key. Required.
@@ -38,4 +39,4 @@ jobs:
 
           # run: |
           #     cat config.json
-          #     docker run -it --env-file=.env -e "CONFIG=$(cat config.json | jq -r tostring)" typesense/docsearch-scraper:0.9.1
+          #     docker run -it --env-file=.env -e "CONFIG=$(cat config.json | jq -r tostring)" typesense/docsearch-scraper:0.9.1

.gitignore

@@ -8,6 +8,9 @@
 .docusaurus
 .cache-loader
 
+# Temp (unnecessary / local-only files moved here)
+/temp
+
 # Misc
 .DS_Store
 .env.local