Skip to content

Commit 0814e91

Browse files
committed
Merge branch 'ruby-dev-guide' of github.com:temporalio/documentation into ruby-dev-guide
2 parents aae34a2 + e11b9b3 commit 0814e91

File tree

1 file changed

+22
-25
lines changed

1 file changed

+22
-25
lines changed

docs/develop/ruby/set-up-local-ruby.mdx

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ tags:
1313
---
1414

1515
# Quick Start – Ruby SDK
16-
This guide walks you through setting up the Temporal Ruby SDK and running your first Workflow.
16+
17+
This guide walks you through setting up the Temporal Ruby SDK and running your first Workflow.
1718
In just a few steps, you'll install the SDK, start a local development server, and see a Workflow in action.
1819

1920
## 1. Installation
@@ -23,29 +24,29 @@ Install the Temporal SDK using your preferred method.
2324
<Tabs>
2425
<TabItem value="gemfile" label="Gemfile">
2526

26-
```ruby
27-
gem 'temporalio'
28-
```
27+
```ruby
28+
gem 'temporalio'
29+
```
2930

30-
This approach is used in Ruby projects that manage dependencies with Bundler.
31+
This approach is used in Ruby projects that manage dependencies with Bundler.
3132

32-
To install it, add the line to your project's Gemfile and run `bundle install` in your terminal.
33-
Bundler will download and install the gem and its dependencies.
33+
To install it, add the line to your project's Gemfile and run `bundle install` in your terminal.
34+
Bundler will download and install the gem and its dependencies.
3435

3536
</TabItem>
3637
</Tabs>
3738

3839
<Tabs>
3940
<TabItem value="cli" label="Command Line (gem install)">
4041

41-
```bash
42-
gem install temporalio
43-
```
42+
```bash
43+
gem install temporalio
44+
```
4445

4546
</TabItem>
4647
</Tabs>
4748

48-
Both methods will install the same Temporal SDK, which supports Ruby versions 3.2, 3.3, and 3.4.
49+
Both methods will install the same Temporal SDK, which supports Ruby versions 3.2, 3.3, and 3.4.
4950

5051
> **Note:**
5152
>
@@ -55,10 +56,9 @@ Both methods will install the same Temporal SDK, which supports Ruby versions 3.
5556
> - `fibers`/`async` are only supported on Ruby **3.3+**.
5657
> - See [Platform Support](#) for full details.
5758
58-
5959
## 2. Start the Temporal Server Locally
6060

61-
With the SDK installed, you’ll need a local Temporal Server to run your Workflows.
61+
With the SDK installed, you’ll need a local Temporal Server to run your Workflows.
6262
The easiest way to do this is with [**Temporal CLI**](https://docs.temporal.io/dev-guide/cli/).
6363

6464
<Tabs groupId="os" queryString>
@@ -70,7 +70,7 @@ You can install the latest version with [Homebrew](https://brew.sh) using the fo
7070
brew install temporal
7171
```
7272

73-
</TabItem>
73+
</TabItem>
7474
<TabItem value="win" label="Windows">
7575

7676
To install Temporal CLI on Windows, download the version for your architecture:
@@ -80,18 +80,17 @@ To install Temporal CLI on Windows, download the version for your architecture:
8080

8181
Once you've downloaded the file, extract the downloaded archive and add the `temporal.exe` binary to your `PATH`.
8282

83-
</TabItem>
83+
</TabItem>
8484
<TabItem value="linux" label="Linux">
8585

86-
8786
To install Temporal CLI, download the version for your architecture:
8887

8988
- [Download Temporal CLI for Linux amd64](https://temporal.download/cli/archive/latest?platform=linux&arch=amd64)
9089
- [Download Temporal CLI for Linux arm64](https://temporal.download/cli/archive/latest?platform=linux&arch=arm64)
9190

9291
Once you've downloaded the file, extract the downloaded archive and add the `temporal` binary to your `PATH` by copying it to a directory like `/usr/local/bin`.
9392

94-
</TabItem>
93+
</TabItem>
9594
</Tabs>
9695

9796
Once installed, run the development server by opening up a new terminal window:
@@ -115,8 +114,7 @@ Leave this running in a separate terminal tab or window while you develop.
115114
> temporal server start-dev --db-filename my_temporal.db
116115
> ```
117116
118-
119-
## 3. Write Your First Activity and Workflow
117+
## 3. Write Your First Activity and Workflow
120118
121119
<Tabs>
122120
<TabItem value="activity" label="Activity (say_hello_activity.rb)">
@@ -129,9 +127,9 @@ require 'temporalio/activity'
129127
"Hello, #{name}!"
130128
end
131129
end
132-
```
130+
```
133131
134-
</TabItem>
132+
</TabItem>
135133
</Tabs>
136134

137135
<Tabs>
@@ -150,12 +148,11 @@ require_relative 'say_hello_activity'
150148
)
151149
end
152150
end
153-
```
151+
```
154152

155153
</TabItem>
156154
</Tabs>
157155

158-
159156
## 4. Run a Worker
160157

161158
<Tabs>
@@ -183,7 +180,7 @@ worker.run(shutdown_signals: ['SIGINT'])
183180
</Tabs>
184181

185182
Workers, which are part of your application and provided by the Temporal SDK, then carry out the tasks defined in your Workflow.
186-
For more information on Workers, see [Understanding Temporal](/evaluate/understanding-temporal#workers) and a [deep dive into Workers](/workers).
183+
For more information on Workers, see [Understanding Temporal](/evaluate/understanding-temporal#workers) and a [deep dive into Workers](/workers).
187184

188185
## 5. Execute a Workflow and See the Result
189186

@@ -215,4 +212,4 @@ puts "Result: #{result}"
215212
Result: Hello, Temporal!
216213
```
217214

218-
To follow more Ruby tutorials, visit learn.temporal.io/ruby.
215+
To follow more Ruby tutorials, visit learn.temporal.io/ruby.

0 commit comments

Comments
 (0)