Skip to content

Commit 3aad0ca

Browse files
karakanbkarakanb
authored
Merge pull request bruin-data#254 from Barbar1432/add-dynamic-outputs
 added dynamic output gifs in docs
2 parents 927948a + 5424854 commit 3aad0ca

17 files changed

+149
-30
lines changed

‎docs/commands/clean.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ bruin clean [path-to-project-root]
1818
bruin clean
1919
```
2020
#### Output:
21-
``` plaintext
22-
Found 107 log files, cleaning them up...
23-
Successfully removed 107 log files.
24-
```
21+
22+
23+
<img alt="Bruin - clean" src="/clean.gif" style="margin: 10px;" />

‎docs/commands/init.md

+13
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,16 @@ bruin init --help
2626
```
2727

2828
The output displays the list of available templates.
29+
30+
31+
## Example
32+
33+
### Initializing the Shopify-Bigquery template
34+
35+
``` bash
36+
bruin init shopify-bigquery
37+
```
38+
#### Output:
39+
40+
41+
<img alt="Bruin - clean" src="/init.gif" style="margin: 10px;" />

‎docs/commands/lineage.md

+11-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ This is useful for understanding your pipeline’s structure, tracking relations
1010
```bash
1111
bruin lineage [flags] <path to the asset definition>
1212
```
13-
1413
### Flags
1514

1615
- `--full`
@@ -21,5 +20,16 @@ This is useful for understanding your pipeline’s structure, tracking relations
2120
- `plain` (default): Outputs a human-readable text summary.
2221
- `json`: Outputs the lineage as structured JSON.
2322

23+
24+
## Example
25+
26+
### Understanding the dependencies of Chess template
27+
28+
``` bash
29+
bruin lineage chess/assets/player_summary.sql
30+
```
31+
#### Output:
32+
2433

34+
<img alt="Bruin - clean" src="/lineage2.gif" style="margin: 10px;" />
2535

‎docs/commands/render.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ It supports multiple databases and output formats, making it a flexible tool for
88
```bash
99
bruin render [path to asset definition] [flags]
1010
```
11-
11+
<img alt="Bruin - clean" src="/render.gif" style="margin: 10px;" />
1212
### Arguments
1313

1414
**path-to-asset-definition* (required):

‎docs/commands/run.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This command is used to execute a Bruin pipeline or a specific asset within a pi
1313
```bash
1414
bruin run [FLAGS] [optional path to the pipeline/asset]
1515
```
16-
16+
<img alt="Bruin - init" src="/chesspipeline.gif" style="margin: 10px;" />
1717
## Flags
1818

1919
| Flag | Type | Default | Description |

‎docs/commands/validate.md

+3-9
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ It ensures that the configurations meet specific requirements and are properly c
88
```bash
99
bruin validate [path to pipelines] [flags]
1010
```
11+
<img alt="Bruin - validate" src="/validate.gif" style="margin: 10px;" />
1112
**Arguments:**
1213

1314
**[path to pipelines]:** Path to the pipeline directory or a specific asset.
@@ -31,22 +32,15 @@ Defaults to the current directory (".") if not provided.
3132
bruin validate
3233
```
3334

34-
**2. Validate pipelines in a specified directory:**
35-
36-
```bash
37-
bruin validate
38-
```
39-
40-
41-
**3. Validate with JSON output:**
35+
**2. Validate with JSON output:**
4236

4337
```bash
4438
bruin validate --output json
4539

4640
```
4741

4842

49-
**4. Validate a specific asset:**
43+
**3. Validate a specific asset:**
5044

5145
```bash
5246
bruin validate path/to/specific-asset

‎docs/getting-started/templates.md

+3-14
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,9 @@ To initialize a project using the wizard, simply run:
2323
bruin init
2424
```
2525
As shown below, this will launch a terminal-based wizard:
26-
```plaintext
27-
bin/bruin init
28-
[ ] default
29-
[ ] duckdb
30-
[ ] firebase
31-
[ ] gorgias
32-
[x] notion
33-
[ ] python
34-
[ ] redshift
35-
[ ] shopify-bigquery
36-
[ ] shopify-duckdb
37-
38-
(press q to quit)
39-
```
26+
27+
<img alt="Bruin - init" src="/init-wizard.gif" style="margin: 10px;" />
28+
4029
You can navigate through the available templates using the up and down arrow keys. Once you've selected your desired template, press Enter to confirm.
4130
The wizard will automatically create the folder and set up the project for you.
4231
### Manual template selection

‎docs/public/clean.gif

27.6 KB
Loading

‎docs/public/init-wizard.gif

109 KB
Loading

‎docs/public/init.gif

49.3 KB
Loading

‎docs/public/lineage2.gif

75.3 KB
Loading

‎resources/clean.tape

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Output location for the GIF
2+
Output ../docs/public/clean.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1000
7+
Set Height 400
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin clean"
14+
Enter
15+
Sleep 10s

‎resources/init-wizard.tape

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Output location for the GIF
2+
Output ../docs/public/init-wizard.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1300
7+
Set Height 1200
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin init"
14+
Enter
15+
Sleep 3s
16+
17+
# Simulate pressing the down arrow key three times and then Enter
18+
Down
19+
Sleep 1s
20+
Down
21+
Sleep 1s
22+
Down
23+
Sleep 1s
24+
Down
25+
Sleep 1s
26+
Down
27+
Sleep 1s
28+
Down
29+
Sleep 1s
30+
Sleep 1s
31+
Down
32+
Sleep 1s
33+
Enter
34+
35+
# Allow time to log the output after selection
36+
Sleep 8s
37+
38+
39+
# End of script

‎resources/init.tape

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Output location for the GIF
2+
Output ../docs/public/init.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1300
7+
Set Height 500
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin init shopify-bigquery"
14+
Enter
15+
Sleep 5s

‎resources/lineage.tape

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Output location for the GIF
2+
Output ../docs/public/lineage2.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1200
7+
Set Height 900
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin lineage chess/assets/player_summary.sql "
14+
Enter
15+
Sleep 10s

‎resources/render.tape

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Output location for the GIF
2+
Output ../docs/public/render.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1200
7+
Set Height 1200
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin render chess/assets/player_summary.sql "
14+
Enter
15+
Sleep 10s

‎resources/validate.tape

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Output location for the GIF
2+
Output ../docs/public/validate.gif
3+
4+
# Set up terminal dimensions and appearance
5+
Set FontSize 20
6+
Set Width 1100
7+
Set Height 600
8+
Set LineHeight 1.8
9+
Set TypingSpeed 0.1
10+
Set Framerate 60
11+
12+
# Simulate typing the commands
13+
Type "bruin validate gorgias"
14+
Enter
15+
Sleep 5s

0 commit comments

Comments
 (0)