Cadence Next (#200)

* add docusaurus to gitignore * rebase upstream * document dependencies * blog metadata updates for authors and tags * blog sidebar updates * blog: cadence workflows github organization * move repo to cadence-workflows/Cadence-Docs * rename links to cadence-workflow org * rebase upstream * fix broken link * fix broken link * fix broken link * navigation updates * team bio info * add resources file * use npm instead of yarn * add activity failures to sidebar * rebase upstream * rebase upstream * rebase upstream * add truncate directives on markdown * add survey announcement * remove redundant gtag.js * update dependencies * update team description * update packages * update team bios * update sidebar * add team member info * update navigation * blue version of svg * minor content updates * mirror colors from uber base web * jargon remark plugin * activate jargon plugin * update docusaurus version * env for build configuration * add workflow-troubleshooting/retries to sidebar * remove vuepress config * update deploy path for gh actions * update deploy gh pages action * update build and deploy gh-pages configuration * grant permission for job to publish * blog post formatting * fix build status badges * update team bios * add site description meta tag * add codeblock type * blog syntax highlighting improvements * docs syntax highlighting improvements * custom dql syntax highlighting support * docs syntax highlighting improvements * style updates * fix styles when css is minified * syntax highlighting improvements * remove trailing slash from url by default * fix links
cadence-workflow · Dec 17, 2024 · 82bf0bc · 82bf0bc
1 parent 4ebbcfc
commit 82bf0bc
Show file tree

Hide file tree

Showing 237 changed files with 16,378 additions and 34,479 deletions.
diff --git a/.envrc b/.envrc
@@ -5,3 +5,10 @@ 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
+
+# Custom env values go into .envrc.local
+if [ -f .envrc.local ]; then
+  echo "loading .envrc.local"
+  source_env .envrc.local
+fi
+
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,13 +13,15 @@ jobs:
 
     steps:
     - name: Checkout 🛎️
-      uses: actions/checkout@v3
+      # https://github.com/actions/checkout
+      uses: actions/checkout@v4
       with:
         persist-credentials: false
     - name: Use Node.js v18
-      uses: actions/setup-node@v3
+      # https://github.com/actions/setup-node
+      uses: actions/setup-node@v4
       with:
-        node-version: 18.x
+        node-version: lts/hydrogen
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
         cache: 'npm'
     - name: Install and Build 🔧

diff --git a/.github/workflows/publish-to-gh-pages.yml b/.github/workflows/publish-to-gh-pages.yml
@@ -1,23 +1,36 @@
 name: Build and Deploy
 on:
+  workflow_dispatch:
   push:
     branches:
       - master
 
+permissions:
+  contents: write
+
 jobs:
   build-and-deploy:
     runs-on: ubuntu-latest
 
+    # Load environment variables from repository settings,
+    # environment should be named "production"
+    # https://github.com/cadence-workflow/Cadence-Docs/settings/environments
+    environment: production
+    env:
+      CADENCE_DOCS_URL: ${{ vars.CADENCE_DOCS_URL || 'https://cadenceworkflow.io' }}
+      CADENCE_DOCS_BASE_URL: ${{ vars.CADENCE_DOCS_BASE_URL || '/Cadence-Docs/' }}
+      CADENCE_DOCS_ORGANIZATION: ${{ vars.CADENCE_DOCS_ORGANIZATION || 'cadence-workflow' }}
+
     steps:
       # same as build.yml
       - name: Checkout 🛎️
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           persist-credentials: false
-      - name: Use Node.js v18
-        uses: actions/setup-node@v3
+      - name: Use Node.js lts/hydrogen (v18)
+        uses: actions/setup-node@v4
         with:
-          node-version: 18.x
+          node-version: lts/hydrogen
           # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
           cache: 'npm'
       - name: Install and Build 🔧
@@ -29,12 +42,11 @@ jobs:
       - name: Configure domain
         uses: finnp/[email protected]
         env:
-          FILE_NAME: "dist/CNAME"
+          FILE_NAME: "build/CNAME"
           FILE_DATA: ${{ secrets.CUSTOM_DOMAIN }}
       - name: Deploy 🚀
-        uses: JamesIves/github-pages-deploy-action@3.7.1
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages # The branch the action should deploy to.
-          FOLDER: dist # The folder the action should deploy.
-          CLEAN: true # Automatically remove deleted files from the deploy branch
+          branch: gh-pages # The branch the action should deploy to.
+          folder: build # The folder the action should deploy.
+          clean: true # Automatically remove deleted files from the deploy branch
diff --git a/.gitignore b/.gitignore
@@ -1,13 +1,40 @@
+### macOS ###
+# General
 .DS_Store
+.AppleDouble
+.LSOverride
+
+# cypress
 cypress/fixtures
 cypress/plugins
 cypress/support
 cypress/videos
-dist
-dist-blog
-node_modules
-npm-debug.log
+
+# dependencies
+/node_modules
+
 # package-lock file is required for cypress github action to work.
 # See https://github.com/marketplace/actions/cypress-io#installation for more information.
 # package-lock.json
 yarn-error.log
+
+### VisualStudioCode ###
+.vscode/*
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.envrc.local
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/README.md b/README.md
@@ -1,19 +1,72 @@
-# [Cadence docs](https://cadenceworkflow.io) &middot; ![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.jparrowsec.cn%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.jparrowsec.cn%2Fuber%2FCadence-Docs%2Factions%2Fworkflows%2Fnightly-integration-test.yml)
+# [Cadence docs](https://cadenceworkflow.io) &middot; ![Build and Deploy](https://img.shields.io/github/actions/workflow/status/cadence-workflow/Cadence-Docs/publish-to-gh-pages.yml?label=Build%20and%20Deploy&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fcadence-workflow%2FCadence-Docs%2Factions%2Fworkflows%2Fpublish-to-gh-pages.yml) ![Nightly integration test](https://img.shields.io/github/actions/workflow/status/cadence-workflow/Cadence-Docs/nightly-integration-test.yml?label=Nightly%20integration%20test&link=https%3A%2F%2Fgithub.jparrowsec.cn%2Fcadence-workflow%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`
+# cadenceworkflow.io
+
+[Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/).
+
+
+
+### Installation
+
+```console
+$ npm install
+```
+
+### Local Development
+
+```console
+$ npm run start
+```
+
+This command starts a local development server and opens up a browser window at http://localhost:3000/. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```console
+$ npm run build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Environment Variables
+
+In order to deploy to multiple environments, some configuration options in `docusaurus.config.ts` are made available for override through environment variables.
+
+```bash
+# Can be replaced by your GH pages url, ie. https://<userId>.github.io/
+CADENCE_DOCS_URL=https://cadenceworkflow.io
+
+# For GitHub pages deployment, it is often /<projectName>/ defaults to `/`
+CADENCE_DOCS_BASE_URL=/cadence-docs/
+
+# For Github pages only, this is your Github org/user name.
+CADENCE_DOCS_ORGANIZATION=cadence-workflow
+```
+
+### Deployment
+
+Using SSH:
+
+```console
+$ USE_SSH=true npm run deploy
+```
+
+Not using SSH:
+
+```console
+$ GIT_USER=<Your GitHub username> npm run deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+
+
+# NPM Registry
+
+Ensure you have a `.npmrc` [file](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc/) configured with `registry=https://registry.npmjs.org/`.
+This will ensure the dependencies are pulled from the correct source and to prevent internal npm registries from being pushed onto the package-lock.json
 
 ## License
 
-MIT License, please see [LICENSE](https://github.com/uber/Cadence-Docs/blob/master/LICENSE) for details.
+MIT License, please see [LICENSE](https://github.com/cadence-workflow/Cadence-Docs/blob/master/LICENSE) for details.
diff --git a/...-the-cadence-project-and-its-community.md → ...-the-cadence-project-and-its-community.md b/...-the-cadence-project-and-its-community.md → ...-the-cadence-project-and-its-community.md
@@ -1,8 +1,9 @@
 ---
 title: Long-term commitment and support for the Cadence project, and its community
 date: 2021-09-30
-author: Liang Mei
-authorlink: https://www.linkedin.com/in/meiliang86/
+authors: meiliang86
+tags:
+  - announcement
 ---
 
 Dear valued Cadence users and developers,
@@ -11,10 +12,11 @@ Dear valued Cadence users and developers,
 Some of you might have read Temporal’s recent announcement about their decision to drop the support for the Cadence project. This message caused some confusion in the community, so we would like to take this opportunity to clear things out.
 
 
-First of all, **Uber is committed to the long-term success of the Cadence project**. Since its inception 5 years ago, use cases built on Cadence and their scale have grown significantly at Uber. Today, Cadence powers a variety of our most business-critical use cases (some public stories are available [here](https://eng.uber.com/hadoop-container-blog/) and [here](https://eng.uber.com/meet-sao-paulo-tech/)). At the same time, the Cadence development team at Uber has enjoyed rapid growth with the product and has been driving innovations of workflow technology across the board, from new features (e.g. [graceful failover](https://github.com/uber/cadence/pulls?q=is%3Apr+graceful+failover), [workflow shadowing](https://cadenceworkflow.io/docs/java-client/workflow-replay-shadowing/#workflow-replayer), [UI improvements](https://github.com/uber/cadence-web/commits/master)) to better engineering foundations (e.g. [gRPC support](https://github.com/uber/cadence/pulls?q=is%3Apr+grpc), [multi-tenancy support](https://github.com/uber/cadence/pulls?q=is%3Apr+label%3A%22cadence+multi-tenancy%22+)), all in a backwards compatible manner. Neither Uber’s use nor support of Cadence is going to change with Temporal’s announcement. We have a long list of features and exciting roadmaps ahead of us, and we will share more details in our next meetup in November ‘21. As always we will continue to push the boundaries of scale and reliability as our usage within Uber grows.
+First of all, **Uber is committed to the long-term success of the Cadence project**. Since its inception 5 years ago, use cases built on Cadence and their scale have grown significantly at Uber. Today, Cadence powers a variety of our most business-critical use cases (some public stories are available [here](https://eng.uber.com/hadoop-container-blog/) and [here](https://eng.uber.com/meet-sao-paulo-tech/)). At the same time, the Cadence development team at Uber has enjoyed rapid growth with the product and has been driving innovations of workflow technology across the board, from new features (e.g. [graceful failover](https://github.com/cadence-workflow/cadence/pulls?q=is%3Apr+graceful+failover), [workflow shadowing](https://cadenceworkflow.io/docs/java-client/workflow-replay-shadowing/#workflow-replayer), [UI improvements](https://github.com/cadence-workflow/cadence-web/commits/master)) to better engineering foundations (e.g. [gRPC support](https://github.com/cadence-workflow/cadence/pulls?q=is%3Apr+grpc), [multi-tenancy support](https://github.com/cadence-workflow/cadence/pulls?q=is%3Apr+label%3A%22cadence+multi-tenancy%22+)), all in a backwards compatible manner. Neither Uber’s use nor support of Cadence is going to change with Temporal’s announcement. We have a long list of features and exciting roadmaps ahead of us, and we will share more details in our next meetup in November ‘21. As always we will continue to push the boundaries of scale and reliability as our usage within Uber grows.
 
+<!-- truncate -->
 
-Secondly, **we are committed to maintaining and growing a healthy and collaborative community**. Cadence continues to attract attention as a [popular open source platform](https://star-history.t9t.io/#uber/cadence), with more than 100 contributors to our project, and more than 1500 developers in our [open source Slack support channel](https://t.uber.com/cadence-slack). The Uber Cadence team, along with our open source partners like [Long](https://www.linkedin.com/in/prclqz/) from Indeed, have been behind the management and support of the Cadence open source community for the past 2 years. Moving forward, we are going to work even more closely with our community, through a series of online and offline channels including meetups, office hours, tech deep dives, and design consultations. We would also like to scale the way we operate, by creating a **Cadence OSS Committee** that allows us to maintain a closer relationship with its members, so that we can learn from each other's Cadence experiences and grow together. Please definitely let us know your suggestions on the type of engagements that you would like to see with the core team.
+Secondly, **we are committed to maintaining and growing a healthy and collaborative community**. Cadence continues to attract attention as a [popular open source platform](https://star-history.t9t.io/#cadence-workflow/cadence), with more than 100 contributors to our project, and more than 1500 developers in our [open source Slack support channel](https://t.uber.com/cadence-slack). The Uber Cadence team, along with our open source partners like [Long](https://www.linkedin.com/in/prclqz/) from Indeed, have been behind the management and support of the Cadence open source community for the past 2 years. Moving forward, we are going to work even more closely with our community, through a series of online and offline channels including meetups, office hours, tech deep dives, and design consultations. We would also like to scale the way we operate, by creating a **Cadence OSS Committee** that allows us to maintain a closer relationship with its members, so that we can learn from each other's Cadence experiences and grow together. Please definitely let us know your suggestions on the type of engagements that you would like to see with the core team.
 
 
 **About Temporal and its “EOL announcement”**

diff --git a/...oss-office-hours-and-community-sync-up.md → ...oss-office-hours-and-community-sync-up.md b/...oss-office-hours-and-community-sync-up.md → ...oss-office-hours-and-community-sync-up.md
@@ -2,8 +2,10 @@
 title: Announcing Cadence OSS office hours and community sync up
 
 date: 2021-10-13
-author: Liang Mei
-authorlink: https://www.linkedin.com/in/meiliang86/
+authors: meiliang86
+tags:
+  - announcement
+  - roadmap
 ---
 
 Are you a current Cadence user, do you operate Cadence services, or are you interested in learning about workflow technologies and wonder what problems Cadence could solve for you? We would like to talk to you!
@@ -29,5 +31,6 @@ Building and maintaining a healthy and growing community is the key to the succe
 
 As we have a geo-distributed userbase, we are still trying to figure out a time that works for most of the people. In the meanwhile, we will manually schedule the first few instances of the meeting until we settle on a fixed schedule. Our next office hours will take place on **Thursday, October 21 2pm-3pm PT/5pm-6pm EST/9pm-10pm GMT**. Please join via [this zoom link](https://uber.zoom.us/j/92356466350?pwd=RFVTc2pwV0xoVTdlK3VxN3N2eU5UZz09).
 
+<!-- truncate -->
 
-The Uber Cadence team
+The Uber Cadence team