Skip to content

Commit 043285f

Browse files
authored
chore: Proofread entire Cadence-Docs repo (cadence-workflow#316)
* docs(community): proofread and fix spelling, grammar, and punctuation - Fix capitalization: Github → GitHub, StackOverflow → Stack Overflow - Fix spelling: fedback → feedback - Fix punctuation: add missing periods, correct 'i.e.' usage - Fix grammar: sentence fragments, awkward phrasing - Remove duplicate H1 headers (title already in frontmatter) - Update http → https links Files changed: - governance.mdx - support.mdx - how-to-contribute/getting-started.mdx - how-to-contribute/pull-request-conventions.mdx - how-to-contribute/ways-to-contribute.mdx Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs(glossary): fix spelling, grammar, and punctuation - Fix spelling: correponding → corresponding, correspondent → corresponding - Fix grammar: an decision → a decision, list of decision → list of decisions - Remove double spaces and extra words - Add missing periods at end of definitions - Remove duplicate H1 header Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs(get-started): fix spelling, grammar, and punctuation - Remove duplicate H1 headers (title already in frontmatter) - Fix capitalization: cadence → Cadence, StackOverflow → Stack Overflow, Github → GitHub, Elastic Search → Elasticsearch - Fix typos: HellowWorld → HelloWorld, for you → for your - Fix grammar: which take → which takes, at background → in the background - Add missing periods, remove double spaces Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs(use-cases): fix spelling, grammar, and punctuation - Remove duplicate H1 headers (title already in frontmatter) - Fix grammar: is also huge → is also a huge, correspondent → corresponding, as compared by → as compared to, which each → with each - Fix typos: Half a a minute → Half a minute, overgenous → overgenerous - Add Oxford comma, remove trailing colon from link text Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs: proofread docs/03-concepts/ folder - Remove H1 headers (handled by Docusaurus frontmatter) - Fix spelling: queing→queuing, ocurring→occurring, reliablity→reliability, retriving→retrieving, worklfows→workflows, IDResuePolicy→IDReusePolicy - Fix grammar: it's state→its state, make make→make, relay on→rely on - Fix punctuation and formatting consistency - Update cadence-web URL from uber/cadence-web to cadence-workflow/cadence-web - Remove internal Uber link from workflow-queries-formatted-data.md - Fix frontmatter formatting in mutual-tls.md Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs: proofread docs/04-java-client/ folder - Remove H1 headers (handled by Docusaurus frontmatter) - Fix spelling: ExperiationInterval to ExpirationInterval, utilises to utilizes, initialised to initialized, sate to state - Fix grammar: recommend to use to recommend using, MUST NOT passing to MUST NOT pass, a incompatible to an incompatible, written since to written as if - Fix article usage: an com.uber to a com.uber - Fix incomplete sentence in queries.md Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs: proofread docs/05-go-client/ folder - Remove H1 headers (handled by Docusaurus frontmatter) - Fix spelling: utilising to utilizing, programing to programming, erorrs to errors - Fix grammar: There two parts to There are two parts, functions needs to functions need - Fix capitalization: build-in to built-in, golang to Go - Fix typos: ExecuteChildworkflow to ExecuteChildWorkflow, the the to the - Fix verb agreement: heartbeat its to heartbeats its, method is to method are - Fix tense: send to sent in testing signals section - Fix code comments: # to // for Go syntax Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * docs: proofread remaining docs folders (codelabs, cli, operation-guide, workflow-troubleshooting, releases, about) Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> * blog: proofread all blog posts (fix typos, grammar, broken links) Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com> --------- Signed-off-by: “Kevin” <kevlar_ksb@yahoo.com>
1 parent 1b48d11 commit 043285f

File tree

111 files changed

+173
-342
lines changed

Some content is hidden

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

111 files changed

+173
-342
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
[Cadence docs](https://cadenceworkflow.io) is built using [Docusaurus](https://docusaurus.io/).
88

9-
> 📚 **New to contributing to Cadence?** Check out our [Contributing Guide](https://cadenceworkflow.io/community/how-to-contribute/getting-started) for an overview of the contribution process across all Cadence repositories. This document contains cadence backend specific setup and development instructions.
9+
> 📚 **New to contributing to Cadence?** Check out our [Contributing Guide](https://cadenceworkflow.io/community/how-to-contribute/getting-started) for an overview of the contribution process across all Cadence repositories. This document contains Cadence backend specific setup and development instructions.
1010
1111
### Installation
1212

@@ -35,19 +35,19 @@ This command generates static content into the `build` directory and can be serv
3535
In order to deploy to multiple environments, some configuration options in `docusaurus.config.ts` are made available for override through environment variables.
3636

3737
```bash
38-
# Can be replaced by your GH pages url, ie. https://<userId>.github.io/
38+
# Can be replaced by your GH pages URL, i.e., https://<userId>.github.io/
3939
CADENCE_DOCS_URL=https://cadenceworkflow.io
4040

4141
# For GitHub pages deployment, it is often /<projectName>/ defaults to `/`
4242
BASE_URL=/cadence-docs/
4343

44-
# For Github pages only, this is your Github org/user name.
44+
# For GitHub pages only, this is your GitHub org/user name.
4545
ORGANIZATION_NAME=cadence-workflow
4646
```
4747

4848
#### CNAME
4949

50-
A file `static/CNAME` should be present in order to deploy to a [github pages site that uses a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site). I.E. cadenceworkflow.io
50+
A file `static/CNAME` should be present in order to deploy to a [GitHub pages site that uses a custom domain](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site), i.e., cadenceworkflow.io.
5151
This file is created by the deploy action, but if deploying from a local environment, care should be taken to ensure the file exists.
5252

5353
### Deployment
@@ -69,10 +69,10 @@ If you are using GitHub pages for hosting, this command is a convenient way to b
6969

7070
### Updating Release Data
7171

72-
The release pages rely on data from GitHub that is persisted as json files under `static/data/releases/`.
72+
The release pages rely on data from GitHub that is persisted as JSON files under `static/data/releases/`.
7373
In order to update the release information for display, this can be done manually or be set up as part of the CI/CD process by running the `scripts/fetch-releases.sh` script. Script uses the [GitHub CLI](https://cli.github.com/) to fetch the release data.
7474

75-
Automatic updates to release data are performed by a github action `fetch-release-data`. Which will check if new data is available, and if so update the release data with the latest information and open a branch named `fetch-release-data` and open a PR if one is not open already.
75+
Automatic updates to release data are performed by a GitHub Action `fetch-release-data`, which will check if new data is available, and if so, update the release data with the latest information and open a branch named `fetch-release-data` and open a PR if one is not open already.
7676

7777
Manual approval is required before merging and continuing to deployment.
7878

blog/2022-05-31-community-spotlight-update-may-2022.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ We are always looking for ways to encourage project participation. It doesn't m
2929

3030
## Share Your News!
3131

32-
Our #support [Slack](http://t.uber.com/cadence-slack) channel is always full of questions and activity so we know that there are are lot of people out there exploring, trying out and setting up Cadence. We are always interested in hearing about what the community are doing so if you have something to you want to share as a blog post or part of this montly update then please contact us in the #community [Slack](http://t.uber.com/cadence-slack) channel.
32+
Our #support [Slack](http://t.uber.com/cadence-slack) channel is always full of questions and activity so we know that there are are lot of people out there exploring, trying out and setting up Cadence. We are always interested in hearing about what the community are doing so if you have something you want to share as a blog post or part of this monthly update then please contact us in the #community [Slack](http://t.uber.com/cadence-slack) channel.
3333

3434
## Next Cadence Technical Office Hours: 3rd and 27th June 2022
3535

blog/2022-06-30-community-spotlight-update-june-2022.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ If you have any ideas or comments about how we can improve our community office
2727

2828
## Cadence Stability Improvements
2929

30-
Is Cadence getting better? Yes it is! Many of you may have noticed that Cadence is improving.That is because of the amount of work being done behind the scenes. The Cadence core team has been doing a lot of work to stabilise Cadence functionality. Keep watching out for even more improvements!
30+
Is Cadence getting better? Yes it is! Many of you may have noticed that Cadence is improving. That is because of the amount of work being done behind the scenes. The Cadence core team has been doing a lot of work to stabilise Cadence functionality. Keep watching out for even more improvements!
3131

3232
## Sprechen Sie Deutsch?
3333

blog/2022-08-31-community-spotlight-august-2022.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ If you are interested in speaking at our next meetup then please contact [Ender
4444

4545
## Looking for a Cadence Role?
4646

47-
The Cadence teeam at Uber are recruiting for a Fullstack Engineer. If you are interested then please contact [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) for more details.
47+
The Cadence team at Uber is recruiting for a Fullstack Engineer. If you are interested then please contact [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) for more details.
4848

4949
## Cadence in the News!
5050

blog/2022-09-30-community-spotlight-september-2022.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Please see below for a roundup of the highlights:
1515

1616
A Cadence talk by [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) and [Ben Slater](https://www.linkedin.com/in/ben-slater-2720562/) has been accepted for [Developer Week Enterprise](https://www.developerweek.com/global/conference/enterprise/).
1717

18-
The talk is scheduled to for 16th November so please make a note in your calendars.
18+
The talk is scheduled for 16th November so please make a note in your calendars.
1919

2020
# Sharing Knowledge
2121

blog/2022-10-31-community-spotlight-october-2022.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,19 @@ Please see below for a roundup of the highlights:
1515

1616
It's always great to get the community together and we had planned to run another Cadence Meetup in early November. Unfortunately we didn't have enough time to get things organised so we've decided to postpone it. So please watch out for an announcement for the new Cadence meetup date.
1717

18-
## Doordash Technnical Showcase Featuring Cadence
18+
## DoorDash Technical Showcase Featuring Cadence
1919

2020
We have had some great feedback from people who attended Technical Showcase that was run this month by Doordash. It featured their financial products but also highlighted some of the key technologies they use...and guess what Cadence is one of them!
2121

22-
If you missed the session then you will be happy to know that it was recorded and we've inlcuded a link to the [the recording on Youtube](https://www.youtube.com/watch?v=uNwbdQyLpns).
22+
If you missed the session then you will be happy to know that it was recorded and we've included a link to [the recording on YouTube](https://www.youtube.com/watch?v=uNwbdQyLpns).
2323

2424
Thanks to the Doordash team for running the session and helping support Cadence by sharing their knowledge.
2525

2626
<!-- truncate -->
2727

2828
## iWF Support for Cadence ##
2929

30-
Community member [Quanzheng Long](https://www.linkedin.com/in/prclqz/) has been busy working on a new project that has been built on top of Cadence. The project is called [iWF - Interpreter for Workflow](https://github.com/indeedeng/iwf). It's great to see that Cadence is now growing it's own ecosystem!
30+
Community member [Quanzheng Long](https://www.linkedin.com/in/prclqz/) has been busy working on a new project that has been built on top of Cadence. The project is called [iWF - Interpreter for Workflow](https://github.com/indeedeng/iwf). It's great to see that Cadence is now growing its own ecosystem!
3131

3232
Please feel free to take a look and let Long know what you think!
3333

blog/2022-11-30-community-spotlight-november-2022.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@ Please see below for a roundup of the highlights:
1515

1616
This month Uber Engineering published a really nice article on one of the ways they are using Cadence. The article is called [How Uber Optimizes the Timing of Push Notifications using ML and Linear Programming](https://www.uber.com/en-US/blog/how-uber-optimizes-push-notifications-using-ml/).
1717

18-
The Uber team take you through the details of the problem that they are looking to solve, so you can understand the scope limitations and depedencies - so please take a look.
18+
The Uber team take you through the details of the problem that they are looking to solve, so you can understand the scope, limitations, and dependencies - so please take a look.
1919

2020
## Cadence @ DeveloperWeek Enterprise ##
2121

22-
DevNetwork run a series of conferences and during November Cadence was featured in at [DeveloperWeek Enterprise](https://www.developerweek.com/global/conference/enterprise/). [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) and [Ben Slater](https://www.linkedin.com/in/ben-slater-2720562/) presented a talk called [Espress Complex Business Logic as Code with Open Source Cadence!](https://embed.emamo.com/event/developerweek-enterprise-2022/s/express-complex-business-logic-as-code-with-open-source-cadence-WKLMvo).
22+
DevNetwork run a series of conferences and during November Cadence was featured in at [DeveloperWeek Enterprise](https://www.developerweek.com/global/conference/enterprise/). [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) and [Ben Slater](https://www.linkedin.com/in/ben-slater-2720562/) presented a talk called [Express Complex Business Logic as Code with Open Source Cadence!](https://embed.emamo.com/event/developerweek-enterprise-2022/s/express-complex-business-logic-as-code-with-open-source-cadence-WKLMvo).
2323

24-
It is good to see that we are finding new channels for us to present the benefits of using Cadence. Huge hanks to Ben and Ender for the presentation and to everyone that attended.
24+
It is good to see that we are finding new channels for us to present the benefits of using Cadence. Huge thanks to Ben and Ender for the presentation and to everyone that attended.
2525

2626
<!-- truncate -->
2727

blog/2023-01-31-community-spotlight-january-2023.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Please remember that if you have question about Cadence or are facing a specific
2222
## Update on iWF Support for Cadence ##
2323
Last October we featured an update in our monthly blog about [iWF - Interpreter for Workflow](https://github.com/indeedeng/iwf), a project built on top of Cadence by community member [Quanzheng Long](https://www.linkedin.com/in/prclqz/). It was announced recently that iWF has released a [Golang SDK](https://github.com/iworkflowio/iwf-golang-sdk) and updated versions of the [Java SDK and server](https://github.com/indeedeng/iwf).
2424

25-
Long is really keen to get feedback so please take a look at iWF, try them out and presented him any feedback.
25+
Long is really keen to get feedback so please take a look at iWF, try it out and present him with any feedback.
2626
Long has also created a couple of blog posts about iWF that we have featured in the Cadence in the News section below so please take a look.
2727

2828
## Cadence in the News!

blog/2023-03-31-community-spotlight-march-2023.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ We are very pleased to let you know that a talk on Cadence has been accepted for
1616
The talk called [Cadence: The New Open Source Project for Building Complex Distributed Applications](https://ossna2023.sched.com/event/1K5B1) will be given by [Ender Demirkaya](https://www.linkedin.com/in/enderdemirkaya/) and [Emrah Seker](https://www.linkedin.com/in/emrahseker/) If you are planning to attend the Open Source Summit then please don't forget to attend the talk and take time catch up with Ender and Emrah!
1717

1818
## Community Activity ##
19-
Our Slack #support channel has been very active over the last few months as we continue to get an continual stream of questions. Here are the stats:
19+
Our Slack #support channel has been very active over the last few months as we continue to get a continual stream of questions. Here are the stats:
2020

2121
- February 2023 : 16 questions asked
2222
- March 2023 : 12 questions asked

blog/2023-07-16-write-your-first-workflow-with-cadence/2023-07-16-write-your-first-workflow-with-cadence.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ tags:
88
- introduction-to-cadence
99
---
1010

11-
We have covered [basic components of Cadence](/blog/2023-06-28-components-of-cadence-application-setup.md) and [how to implement a Cadence worker on local environment](/blog/2023-07-05-implement-cadence-worker-from-scratch.md) in previous blogs. In this blog, let's write your very first HelloWorld workflow with Cadence. I've started the Cadence backend server in background and registered a domain named `test-domain`. You may use the code snippet for the worker service in [this blog](/blog/2023-07-05-implement-cadence-worker-from-scratch.md) Let's first write a activity, which takes a single string argument and print a log in the console.
11+
We have covered [basic components of Cadence](/blog/2023-06-28-components-of-cadence-application-setup.md) and [how to implement a Cadence worker on local environment](/blog/2023-07-05-implement-cadence-worker-from-scratch.md) in previous blogs. In this blog, let's write your very first HelloWorld workflow with Cadence. I've started the Cadence backend server in background and registered a domain named `test-domain`. You may use the code snippet for the worker service in [this blog](/blog/2023-07-05-implement-cadence-worker-from-scratch.md). Let's first write an activity, which takes a single string argument and prints a log in the console.
1212

1313
```go
1414
func helloWorldActivity(ctx context.Context, name string) (string, error) {

0 commit comments

Comments
 (0)