Skip to content

Commit

Permalink
docs: updates to wizard instructions (#1158)
Browse files Browse the repository at this point in the history
* docs: pointers for fresh dbt installs

* package updates

* add pnpm lock
  • Loading branch information
ccerv1 authored Mar 30, 2024
1 parent 0ea7b3e commit b990ec6
Show file tree
Hide file tree
Showing 3 changed files with 185 additions and 83 deletions.
30 changes: 17 additions & 13 deletions apps/docs/docs/contribute/impact-models.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,30 +68,34 @@ cd oso

### Run the Wizard

The next step is to install the python dependencies and run the wizard which
will ask you to run `dbt` at the end (Say yes if you'd like to copy the
oso_playground dataset). Simply run:
First, authenticate with `gcloud`:

```bash
poetry install && poetry run oso_lets_go
gcloud auth application-default login
```

Once this is completed, you'll have a full "playground" of your own. If you make
any changes and would like to rerun dbt simply do:
Next, install the Python dependencies and run the wizard. It will ask you
to run `dbt` at the end (Say yes if you'd like to copy the
oso_playground dataset). Simply run:

```bash
poetry run dbt run
poetry install && poetry run oso_lets_go
```

:::tip
If you would like to remove the need to type `poetry run` all the time, you
can do:
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
type `poetry run` all the time. You can do this by running:

```bash
poetry shell
```

:::
Finally, you can test that everything is working by running the following command:

```bash
dbt run
```

---

Expand Down Expand Up @@ -257,7 +261,7 @@ run` will write to the `opensource-observer.oso_playground` dataset._
It is likely best to target a specific model so things don't take so long on
some of our materializations:

```
```bash
dbt run --select {name_of_your_model}
```

Expand Down Expand Up @@ -297,7 +301,7 @@ When you're ready, you can test your dbt models against your playground by
simply running dbt like so:

```bash
dbt run
dbt run --select {name_of_your_model}
```

If this runs without issue and you feel that you've completed something you'd
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"@docusaurus/preset-classic": "3.1.1",
"@docusaurus/theme-common": "3.1.1",
"@mdx-js/react": "^3.0.0",
"@plasmicapp/react-web": "^0.2.322",
"@plasmicapp/react-web": "^0.2.324",
"clsx": "^2.1.0",
"prism-react-renderer": "^2.3.1",
"react": "^18.2.0",
Expand Down
Loading

0 comments on commit b990ec6

Please sign in to comment.