Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

added dynamic output gifs in docs #254

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions docs/commands/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ bruin clean [path-to-project-root]
bruin clean
```
#### Output:
``` plaintext
Found 107 log files, cleaning them up...
Successfully removed 107 log files.
```


<img alt="Bruin - clean" src="/clean.gif" style="margin: 10px;" />
13 changes: 13 additions & 0 deletions docs/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,16 @@ bruin init --help
```

The output displays the list of available templates.


## Example

### Initializing the Shopify-Bigquery template

``` bash
bruin init shopify-bigquery
```
#### Output:


<img alt="Bruin - clean" src="/init.gif" style="margin: 10px;" />
12 changes: 11 additions & 1 deletion docs/commands/lineage.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ This is useful for understanding your pipeline’s structure, tracking relations
```bash
bruin lineage [flags] <path to the asset definition>
```

### Flags

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


## Example

### Understanding the dependencies of Chess template

``` bash
bruin lineage chess/assets/player_summary.sql
```
#### Output:


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

17 changes: 3 additions & 14 deletions docs/getting-started/templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,20 +26,9 @@ To initialize a project using the wizard, simply run:
bruin init
```
As shown below, this will launch a terminal-based wizard:
```plaintext
bin/bruin init
[ ] default
[ ] duckdb
[ ] firebase
[ ] gorgias
[x] notion
[ ] python
[ ] redshift
[ ] shopify-bigquery
[ ] shopify-duckdb
(press q to quit)
```

<img alt="Bruin - init" src="/init-wizard.gif" style="margin: 10px;" />

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.
The wizard will automatically create the folder and set up the project for you.
### Manual template selection
Expand Down
Binary file added docs/public/clean.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/init-wizard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/init.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/public/lineage2.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 15 additions & 0 deletions resources/clean.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Output location for the GIF
Output ../docs/public/clean.gif

# Set up terminal dimensions and appearance
Set FontSize 20
Set Width 1000
Set Height 400
Set LineHeight 1.8
Set TypingSpeed 0.1
Set Framerate 60

# Simulate typing the commands
Type "bruin clean"
Enter
Sleep 10s
39 changes: 39 additions & 0 deletions resources/init-wizard.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Output location for the GIF
Output ../docs/public/init-wizard.gif

# Set up terminal dimensions and appearance
Set FontSize 20
Set Width 1300
Set Height 1200
Set LineHeight 1.8
Set TypingSpeed 0.1
Set Framerate 60

# Simulate typing the commands
Type "bruin init"
Enter
Sleep 3s

# Simulate pressing the down arrow key three times and then Enter
Down
Sleep 1s
Down
Sleep 1s
Down
Sleep 1s
Down
Sleep 1s
Down
Sleep 1s
Down
Sleep 1s
Sleep 1s
Down
Sleep 1s
Enter

# Allow time to log the output after selection
Sleep 8s


# End of script
15 changes: 15 additions & 0 deletions resources/init.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Output location for the GIF
Output ../docs/public/init.gif

# Set up terminal dimensions and appearance
Set FontSize 20
Set Width 1300
Set Height 500
Set LineHeight 1.8
Set TypingSpeed 0.1
Set Framerate 60

# Simulate typing the commands
Type "bruin init shopify-bigquery"
Enter
Sleep 5s
15 changes: 15 additions & 0 deletions resources/lineage.tape
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Output location for the GIF
Output ../docs/public/lineage2.gif

# Set up terminal dimensions and appearance
Set FontSize 20
Set Width 1200
Set Height 900
Set LineHeight 1.8
Set TypingSpeed 0.1
Set Framerate 60

# Simulate typing the commands
Type "bruin lineage chess/assets/player_summary.sql "
Enter
Sleep 10s