Skip to content

Commit

Permalink
fix: docs edits (#1256)
Browse files Browse the repository at this point in the history
feat: MetricsFlow setup
  • Loading branch information
ryscheng authored Apr 19, 2024
1 parent b5d2211 commit 6a70e87
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions apps/docs/docs/contribute/impact-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ It assumes a basic understanding of SQL and the command line.

Before you begin you'll need the following on your system:

- Python 3.11 or higher (see [here](https://www.python.org/downloads/) if you
- Python >=3.11 (see [here](https://www.python.org/downloads/) if you
don't have it installed)
- Python Poetry (see [here](https://pypi.org/project/poetry/) to install it)
- Python Poetry >= 1.8 (see [here](https://pypi.org/project/poetry/) to install it)
- git (see [here](https://github.com/git-guides/install-git) if you don't have it installed)
- A GitHub account (see [here](https://github.com/join) to open a new account)
- BigQuery access (see [here](../get-started/#login-to-bigquery) if you don't have it setup already)
Expand Down Expand Up @@ -82,6 +82,16 @@ oso_playground dataset). Simply run:
poetry install && poetry run oso_lets_go
```

:::tip
Under the hood, `oso_lets_go` will create a GCP project
and BigQuery dataset if they don't already exist,
and copy a small subset of the OSO data for you to develop against.
It will also create a dbt profile to connect to this dataset
(stored in `~/.dbt/profiles.yml`).
The script is idempotent, so you can safely run it again
if you encounter any issues.
:::

Once this is completed, you'll have a full "playground" of your own.

We strongly recommend running everything in the `poetry shell` so you don't have to
Expand Down

0 comments on commit 6a70e87

Please sign in to comment.