[Docs] New website

.github/workflows/docs.yml

@@ -1,82 +1,75 @@
-name: Docs
+name: Deploy Website
 
-defaults:
-  run:
-    working-directory: ./docs
-
-# Compiles and deploys documentation on:
-#   every push that has a change in the docs folder
-#   every pull request with main branch as the base and has a change in the docs folder
 on:
   push:
     paths:
       - 'docs/**'
+      - 'website/**'
   pull_request:
     branches:
       - main
     paths:
       - 'docs/**'
+      - 'website/**'
+
+defaults:
+  run:
+    working-directory: ./website
 
 jobs:
-  docs:
-    name: Build the docs
-    # TODO: Switch to `ubuntu-latest` when GH internal migration complete
-    # because it has awscli@2 built in.
-    # See `ubuntu-latest` note in: https://docs.github.com/en/actions/reference/specifications-for-github-hosted-runners#supported-runners-and-hardware-resources
-    runs-on: ubuntu-20.04
-    strategy:
-      matrix:
-        node-version: [14.x]
+  deploy-website:
+    runs-on: ubuntu-latest
+
     steps:
       - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
 
-      - name: Get Yarn Cache Directory Path
-        id: cache-dir-path
+      - name: AWS CLI version
+        run: "aws --version"
+
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
         run: echo "::set-output name=dir::$(yarn cache dir)"
 
-      - name: Use Yarn Cache
-        uses: actions/cache@v2
-        id: cache
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
         with:
-          path: ${{ steps.cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('./docs/yarn.lock') }}
-
-      - name: Installation ${{ matrix.node-version }}
-        run: yarn --prefer-offline --frozen-lockfile --non-interactive
-
-      # Used to install the root node_modules necessary for linting
-      - name: Root Node Installation ${{ matrix.node-version }}
-        working-directory: ./
-        run: yarn --prefer-offline --frozen-lockfile --non-interactive
-
-      - name: Check Code ${{ matrix.node-version }}
-        run: yarn check-ci
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('website/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
 
-      - name: Clean Code ${{ matrix.node-version }}
-        run: yarn clean
+      - name: Install Dependencies
+        run: yarn install --frozen-lockfile
 
-      - name: Build Docs ${{ matrix.node-version }}
+      - name: Build the website
         run: yarn build
 
-      # deploy to staging if the branch is not main
-      - name: Deploy Docs (staging)
+      # Use `gh` tool to infer more information about the pull request.
+      # The underlying issue here is pushes to a non-mergeable/main target branch
+      # don't have the PR number easily available.
+      # https://stackoverflow.com/a/70102700
+      - name: Get pull request info
+        id: pr_info
+        run: echo "::set-output name=pull_request_number::$(gh pr view --json number -q .number || echo "")"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Deploy docs (staging)
         if: github.ref != 'refs/heads/main'
         run: yarn deploy:stage
         env:
+          # GH actions have a PR merge commit that _isn't_ our actual commits.
+          # Manually infer correct branch and sha for pull requests.
           FORMIDEPLOY_GIT_SHA: ${{ github.event.pull_request.head.sha }}
+          FORMIDEPLOY_PULL_REQUEST: ${{ steps.pr_info.outputs.pull_request_number }}
           GITHUB_DEPLOYMENT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           SURGE_LOGIN: ${{ secrets.SURGE_LOGIN }}
           SURGE_TOKEN: ${{ secrets.SURGE_TOKEN }}
 
-      # deploy to production only if the branch is main
       - name: Deploy docs (production)
         if: github.ref == 'refs/heads/main'
-        run: yarn run deploy:prod
+        run: yarn deploy:prod
         env:
           GITHUB_DEPLOYMENT_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
-          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}

docs/content/advanced-concepts.md → docs/advanced-concepts.md

@@ -1,6 +1,7 @@
 ---
 title: Advanced Concepts
 order: 2
+sidebar_position: 2
 ---
 
 # Advanced Concepts
@@ -29,8 +30,8 @@ A handful of query parameters are supported within your Spectacle presentation.
 Append your URL with one of the following parameters, like so: `&<parameter>=true`.
 To combine parameters, use multiple `&` to separate the parameters, e.g.: `&exportMode=true&printMode=true`
 
-| Parameter       | Description of Use                                                                                                                                             |
-| --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `exportMode`    | For exporting your presentation as a PDF. Add it to your project URL and "Save to PDF" directly from the browser                                               |
-| `printMode`     | Turns your slideshow into a printer-friendly, black & white version. Meant for use concurrently with `?exportMode` e.g. `?exportMode=true&printMode=true`      |
-| `presenterMode` | Displays a Presenter Mode for ease of presentation. For more info on this mode, please see [Presenting](./basic-concepts#presenting) in our Basic Concepts doc |
+| Parameter       | Description of Use                                                                                                                                        |
+| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `exportMode`    | For exporting your presentation as a PDF. Add it to your project URL and "Save to PDF" directly from the browser                                          |
+| `printMode`     | Turns your slideshow into a printer-friendly, black & white version. Meant for use concurrently with `?exportMode` e.g. `?exportMode=true&printMode=true` |
+| `presenterMode` | Displays a Presenter Mode for ease of presentation. For more info on this mode, please see [Presenting](./#presenting) in our Basic Concepts doc          |

docs/content/api-reference.md → docs/api-reference.md

@@ -1,6 +1,7 @@
 ---
 title: API Reference
 order: 5
+sidebar_position: 5
 ---
 
 # API Reference