Skip to content

Commit 29df214

Browse files
committed
feat: add runnerty platform tutorial
1 parent 7e40146 commit 29df214

File tree

9 files changed

+56
-5
lines changed

9 files changed

+56
-5
lines changed
104 KB
Loading
154 KB
Loading

docs/connect-to-platform.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
id: connect-to-platform
3+
title: 2. Connect to Runnerty Platform
4+
---
5+
6+
[Runnerty Platform](https://app.runnerty.io/) offers a platform to manage your runnerty projects, visualize your chains and processes in real time and much more.
7+
8+
#### 1. Access [Runnerty Platform](https://app.runnerty.io/) and create your project:
9+
10+
![](./assets/runnerty-io-new-project.png)
11+
12+
#### 2. Get your project's API Key:
13+
14+
![](./assets/runnerty-io-api-key.png)
15+
16+
```json {4} title="Enter the API Key in the configuration file of your runnerty project (config.json)"
17+
{
18+
"general": {
19+
"runnerty.io": {
20+
"apikey": "YOUR_APIKEY_HERE!"
21+
}
22+
}
23+
}
24+
```
25+
26+
#### 3. Enjoy Runnerty Platform
27+
28+
In the next start of your project you will be able to visualize and control your processes and chains from Runnerty Platform.
29+
30+
🎉🎉 Congratulations, you are know connected to Runnerty Platform!
31+
32+
You can now visualize your executions
33+
34+
![](./assets/app.runnerty.io-timeline.png)
35+
36+
And your chains definitions
37+
38+
![](./assets/app.runnerty.io-graph.png)
39+
40+
### Runnerty.io Parameters
41+
42+
| Parameter | Default | Description |
43+
| :------------ | :----------------------- | :------------------------------------------------------------------------ |
44+
| disable | false | disable Runnerty Platform connection |
45+
| host | ws-telemetry.runnerty.io | Runnerty Platform enpoint |
46+
| healthChecker | true | enables health signal communication |
47+
| remoteControl | true | enable remote control from Runnerty platform |
48+
| debug | false | enables the debug mode of the communication module (for development only) |

docs/create-project.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ The following contents will be created in your current directory.
3131

3232
2. Run `npm start`.
3333

34-
Congratulations, you have just made your first Runnerty project!
34+
🎉🎉 Congratulations, you have just made your first Runnerty project!
35+
36+
You can know connect to [Runnerty Platform](connect-to-platform).
3537

3638
This workflow executes an `echo` command every minute leaving the response in a log file. The terminal where we run the project is also notified of the beginning and end of the chain.
3739

docs/defaults-processes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: defaults-processes
3-
title: 4. Defaults processes
3+
title: 5. Defaults processes
44
---
55

66
In many occasions we repeat the same `output` or `notifications` configurations of our processes and it is ideal to be able to keep them in one place.

docs/guide-dependencies.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: guide-dependencies
3-
title: 3. Process dependencies
3+
title: 4. Process dependencies
44
---
55

66
This guide explains __how to create dependencies between processes__.

docs/guide-notifiers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: guide-notifiers
3-
title: 2. Monitoring with notifiers
3+
title: 3. Monitoring with notifiers
44
---
55

66
This guide explains __how to plan and monitor__ the execution of a shell command.

docs/share-process-data.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: share-process-data
3-
title: 5. Share process data
3+
title: 6. Share process data
44
---
55

66
This guide explains ** how to share data between processes**.

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ module.exports = {
44
"setup",
55
{"Tutorial": [
66
"setup-create-project",
7+
"connect-to-platform",
78
"guide-notifiers",
89
"guide-dependencies",
910
"defaults-processes",

0 commit comments

Comments
 (0)