Skip to content

Commit a28a93b

Browse files
ibarrajoibarrajo
authored
Cadence Next (#204)
* 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 * update environment variables for deployment * fix format * update environment variables for production deploy * disable deployment for testing
1 parent b792f3b commit a28a93b

File tree

237 files changed

+16417
-34487
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

237 files changed

+16417
-34487
lines changed

‎.envrc‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,10 @@ export NODE_VERSIONS=~/.nvm/versions/node
55
export NODE_VERSION_PREFIX='v'
66
export NODE_OPTIONS=--openssl-legacy-provider
77
use node # reads .node-version, keep in sync with package.json
8+
9+
# Custom env values go into .envrc.local
10+
if [ -f .envrc.local ]; then
11+
echo "loading .envrc.local"
12+
source_env .envrc.local
13+
fi
14+

‎.github/workflows/build.yml‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,15 @@ jobs:
1313

1414
steps:
1515
- name: Checkout 🛎️
16-
uses: actions/checkout@v3
16+
# https://github.com/actions/checkout
17+
uses: actions/checkout@v4
1718
with:
1819
persist-credentials: false
1920
- name: Use Node.js v18
20-
uses: actions/setup-node@v3
21+
# https://github.com/actions/setup-node
22+
uses: actions/setup-node@v4
2123
with:
22-
node-version: 18.x
24+
node-version: lts/hydrogen
2325
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
2426
cache: 'npm'
2527
- name: Install and Build 🔧

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

Lines changed: 59 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,81 @@
11
name: Build and Deploy
22
on:
3+
workflow_dispatch:
34
push:
45
branches:
56
- master
67

8+
permissions:
9+
contents: write
10+
711
jobs:
812
build-and-deploy:
913
runs-on: ubuntu-latest
1014

15+
# Load environment variables from repository settings,
16+
# environment should be named "production"
17+
# https://github.com/cadence-workflow/Cadence-Docs/settings/environments
18+
environment: production
19+
env:
20+
CADENCE_DOCS_URL: ${{ vars.CADENCE_DOCS_URL }}
21+
BASE_URL: ${{ vars.BASE_URL }}
22+
ORGANIZATION_NAME: ${{ vars.ORGANIZATION_NAME }}
23+
1124
steps:
25+
- name: Set environment variables
26+
env:
27+
REPO_NAME: ${{ github.repository }}
28+
id: split
29+
run: |
30+
if [[ -z "${PROJECT_NAME}" ]]; then
31+
echo "PROJECT_NAME not provided, using last part of repository name"
32+
echo "PROJECT_NAME=${REPO_NAME##*/}" >> $GITHUB_ENV
33+
fi
34+
if [[ -z "${BASE_URL}" ]]; then
35+
echo "BASE_URL not provided, using repo name for gh-pages"
36+
echo "BASE_URL=/${REPO_NAME##*/}/" >> $GITHUB_ENV
37+
fi
38+
if [[ -z "${ORGANIZATION_NAME}" ]]; then
39+
echo "ORGANIZATION_NAME not provided, using the first part of the repository name"
40+
echo "ORGANIZATION_NAME=${REPO_NAME/\/*/}" >> $GITHUB_ENV
41+
fi
42+
43+
- name: Test variable
44+
run: |
45+
echo "CADENCE_DOCS_URL is ${CADENCE_DOCS_URL}"
46+
echo "PROJECT_NAME is ${PROJECT_NAME}"
47+
echo "BASE_URL is ${BASE_URL}"
48+
echo "ORGANIZATION_NAME is ${ORGANIZATION_NAME}"
49+
1250
# same as build.yml
1351
- name: Checkout 🛎️
14-
uses: actions/checkout@v3
52+
uses: actions/checkout@v4
1553
with:
1654
persist-credentials: false
17-
- name: Use Node.js v18
18-
uses: actions/setup-node@v3
55+
56+
# configure custom domain for github pages
57+
# files placed under static folder will be copied to the root of the build folder
58+
- name: Configure domain
59+
uses: finnp/[email protected]
60+
env:
61+
FILE_NAME: "static/CNAME"
62+
FILE_DATA: ${{ secrets.CUSTOM_DOMAIN }}
63+
64+
- name: Use Node.js lts/hydrogen (v18)
65+
uses: actions/setup-node@v4
1966
with:
20-
node-version: 18.x
67+
node-version: lts/hydrogen
2168
# See supported Node.js release schedule at https://nodejs.org/en/about/releases/
22-
cache: 'npm'
69+
cache: "npm"
70+
2371
- name: Install and Build 🔧
2472
run: |
2573
npm install
2674
npm run build
2775
28-
# additional steps to deploy
29-
- name: Configure domain
30-
uses: finnp/[email protected]
31-
env:
32-
FILE_NAME: "dist/CNAME"
33-
FILE_DATA: ${{ secrets.CUSTOM_DOMAIN }}
34-
- name: Deploy 🚀
35-
uses: JamesIves/[email protected]
36-
with:
37-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
38-
BRANCH: gh-pages # The branch the action should deploy to.
39-
FOLDER: dist # The folder the action should deploy.
40-
CLEAN: true # Automatically remove deleted files from the deploy branch
76+
# - name: Deploy 🚀
77+
# uses: JamesIves/github-pages-deploy-action@v4
78+
# with:
79+
# branch: gh-pages # The branch the action should deploy to.
80+
# folder: build # The folder the action should deploy.
81+
# clean: true # Automatically remove deleted files from the deploy branch

‎.gitignore‎

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
1+
### macOS ###
2+
# General
13
.DS_Store
4+
.AppleDouble
5+
.LSOverride
6+
7+
# cypress
28
cypress/fixtures
39
cypress/plugins
410
cypress/support
511
cypress/videos
6-
dist
7-
dist-blog
8-
node_modules
9-
npm-debug.log
12+
13+
# dependencies
14+
/node_modules
15+
1016
# package-lock file is required for cypress github action to work.
1117
# See https://github.com/marketplace/actions/cypress-io#installation for more information.
1218
# package-lock.json
1319
yarn-error.log
20+
21+
### VisualStudioCode ###
22+
.vscode/*
23+
24+
# Production
25+
/build
26+
27+
# Generated files
28+
.docusaurus
29+
.cache-loader
30+
31+
# Misc
32+
.envrc.local
33+
.env.local
34+
.env.development.local
35+
.env.test.local
36+
.env.production.local
37+
38+
npm-debug.log*
39+
yarn-debug.log*
40+
yarn-error.log*

‎CHANGELOG.md‎

Whitespace-only changes.

‎CONTRIBUTING.md‎

Whitespace-only changes.

‎README.md‎

Lines changed: 66 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,72 @@
1-
# [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)
1+
# [Cadence docs](https://cadenceworkflow.io) · ![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.com%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.com%2Fcadence-workflow%2FCadence-Docs%2Factions%2Fworkflows%2Fnightly-integration-test.yml)
22

3-
## Setting up for local development
4-
This will start a local server and can be accessed at http://localhost:8080/
5-
1. Run `npm install`
6-
2. Run `npm run start`
73

8-
### Adding pages to docs
9-
1. Add the page under `Cadence-Docs/src/docs` in the correct place in the hierarchy
10-
2. Add the page to `Cadence-Docs/src/.vuepress/config.js`
114

12-
## Setting up for local development for blog pages
13-
This will start a local server and can be accessed at http://localhost:8080/blog
14-
1. Run `npm install`
15-
2. Run `npm run start:blog`
5+
# cadenceworkflow.io
6+
7+
[Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/).
8+
9+
10+
11+
### Installation
12+
13+
```console
14+
$ npm install
15+
```
16+
17+
### Local Development
18+
19+
```console
20+
$ npm run start
21+
```
22+
23+
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.
24+
25+
### Build
26+
27+
```console
28+
$ npm run build
29+
```
30+
31+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
32+
33+
### Environment Variables
34+
35+
In order to deploy to multiple environments, some configuration options in `docusaurus.config.ts` are made available for override through environment variables.
36+
37+
```bash
38+
# Can be replaced by your GH pages url, ie. https://<userId>.github.io/
39+
CADENCE_DOCS_URL=https://cadenceworkflow.io
40+
41+
# For GitHub pages deployment, it is often /<projectName>/ defaults to `/`
42+
BASE_URL=/cadence-docs/
43+
44+
# For Github pages only, this is your Github org/user name.
45+
ORGANIZATION_NAME=cadence-workflow
46+
```
47+
48+
### Deployment
49+
50+
Using SSH:
51+
52+
```console
53+
$ USE_SSH=true npm run deploy
54+
```
55+
56+
Not using SSH:
57+
58+
```console
59+
$ GIT_USER=<Your GitHub username> npm run deploy
60+
```
61+
62+
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.
63+
64+
65+
# NPM Registry
66+
67+
Ensure you have a `.npmrc` [file](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc/) configured with `registry=https://registry.npmjs.org/`.
68+
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
1669

1770
## License
1871

19-
MIT License, please see [LICENSE](https://github.com/uber/Cadence-Docs/blob/master/LICENSE) for details.
72+
MIT License, please see [LICENSE](https://github.com/cadence-workflow/Cadence-Docs/blob/master/LICENSE) for details.

‎src/blog/_posts/2021-09-30-long-term-commitment-and-support-for-the-cadence-project-and-its-community.md‎ renamed to ‎blog/2021-09-30-long-term-commitment-and-support-for-the-cadence-project-and-its-community.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
---
22
title: Long-term commitment and support for the Cadence project, and its community
33
date: 2021-09-30
4-
author: Liang Mei
5-
authorlink: https://www.linkedin.com/in/meiliang86/
4+
authors: meiliang86
5+
tags:
6+
- announcement
67
---
78

89
Dear valued Cadence users and developers,
@@ -11,10 +12,11 @@ Dear valued Cadence users and developers,
1112
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.
1213

1314

14-
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.
15+
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.
1516

17+
<!-- truncate -->
1618

17-
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.
19+
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.
1820

1921

2022
**About Temporal and its “EOL announcement”**

‎src/blog/_posts/2021-10-13-announcing-cadence-oss-office-hours-and-community-sync-up.md‎ renamed to ‎blog/2021-10-13-announcing-cadence-oss-office-hours-and-community-sync-up.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
title: Announcing Cadence OSS office hours and community sync up
33

44
date: 2021-10-13
5-
author: Liang Mei
6-
authorlink: https://www.linkedin.com/in/meiliang86/
5+
authors: meiliang86
6+
tags:
7+
- announcement
8+
- roadmap
79
---
810

911
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
2931

3032
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).
3133

34+
<!-- truncate -->
3235

33-
The Uber Cadence team
36+
The Uber Cadence team

0 commit comments

Comments
 (0)