Merge branch 'master' into feature/company-logos

.envrc

@@ -0,0 +1,7 @@
+set -e
+# use `nvm install` and set up direnv to easily work on cadence-docs.
+# nvm does not need to be sourced to use this, just source it to install node.
+export NODE_VERSIONS=~/.nvm/versions/node
+export NODE_VERSION_PREFIX='v'
+export NODE_OPTIONS=--openssl-legacy-provider
+use node # reads .node-version, keep in sync with package.json

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+# Based on the node.js template, modified because we don't need some of it for such a simple project.
+
+# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs
+
+name: Build
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout 🛎️
+      uses: actions/checkout@v3
+      with:
+        persist-credentials: false
+    - name: Use Node.js v18
+      uses: actions/setup-node@v3
+      with:
+        node-version: 18.x
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+        cache: 'npm'
+    - name: Install and Build 🔧
+      run: |
+        npm install
+        npm run build

.github/workflows/publish-to-gh-pages.yml

@@ -3,26 +3,34 @@ on:
   push:
     branches:
       - master
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
+
     steps:
+      # same as build.yml
       - name: Checkout 🛎️
-        uses: actions/checkout@v2.3.1
+        uses: actions/checkout@v3
         with:
           persist-credentials: false
-
+      - name: Use Node.js v18
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+          cache: 'npm'
       - name: Install and Build 🔧
         run: |
           npm install
           npm run build
 
+      # additional steps to deploy
       - name: Configure domain
         uses: finnp/[email protected]
         env:
           FILE_NAME: "dist/CNAME"
           FILE_DATA: ${{ secrets.CUSTOM_DOMAIN }}
-
       - name: Deploy 🚀
         uses: JamesIves/[email protected]
         with:

.node-version

@@ -0,0 +1 @@
+18

.nvmrc

@@ -0,0 +1 @@
+.node-version

LICENSE

@@ -0,0 +1,17 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,11 +1,19 @@
-# [Cadence docs](https://cadenceworkflow.io) · ![Build and Deploy](https://github.com/uber/cadence-docs/workflows/Build%20and%20Deploy/badge.svg) ![Nightly integration test](https://github.com/uber/cadence-docs/workflows/Nightly%20integration%20test/badge.svg)
+# [Cadence docs](https://cadenceworkflow.io) · ![Build and Deploy](https://img.shields.io/github/actions/workflow/status/uber/Cadence-Docs/publish-to-gh-pages.yml?label=Build%20and%20Deploy&link=https%3A%2F%2Fgithub.com%2Fuber%2FCadence-Docs%2Factions%2Fworkflows%2Fpublish-to-gh-pages.yml) ![Nightly integration test](https://img.shields.io/github/actions/workflow/status/uber/Cadence-Docs/nightly-integration-test.yml?label=Nightly%20integration%20test&link=https%3A%2F%2Fgithub.com%2Fuber%2FCadence-Docs%2Factions%2Fworkflows%2Fnightly-integration-test.yml)
 
 ## Setting up for local development
 This will start a local server and can be accessed at http://localhost:8080/
 1. Run `npm install`
 2. Run `npm run start`
 
+### Adding pages to docs
+1. Add the page under `Cadence-Docs/src/docs` in the correct place in the hierarchy
+2. Add the page to `Cadence-Docs/src/.vuepress/config.js`
+
 ## Setting up for local development for blog pages
 This will start a local server and can be accessed at http://localhost:8080/blog
 1. Run `npm install`
 2. Run `npm run start:blog`
+
+## License
+
+MIT License, please see [LICENSE](https://github.com/uber/Cadence-Docs/blob/master/LICENSE) for details.