Skip to content

Commit 377d2d5

Browse files
authored
better onboarding instructions (#3719)
1 parent c98c35a commit 377d2d5

3 files changed

Lines changed: 24 additions & 9 deletions

File tree

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,12 +139,16 @@ Install SQLMesh through [pypi](https://pypi.org/project/sqlmesh/) by running:
139139
```bash
140140
mkdir sqlmesh-example
141141
cd sqlmesh-example
142-
python -m venv .env
143-
source .env/bin/activate
142+
python -m venv .venv
143+
source .venv/bin/activate
144144
pip install sqlmesh
145+
source .venv/bin/activate # reactivate the venv to ensure you're using the right installation
145146
sqlmesh init duckdb # get started right away with a local duckdb instance
147+
sqlmesh plan # see the plan for the changes you're making
146148
```
147149

150+
> Note: You may need to run `python3` or `pip3` instead of `python` or `pip`, depending on your python installation.
151+
148152
Follow the [quickstart guide](https://sqlmesh.readthedocs.io/en/stable/quickstart/cli/#1-create-the-sqlmesh-project) to learn how to use SQLMesh. You already have a head start!
149153

150154
Follow this [example](https://sqlmesh.readthedocs.io/en/stable/examples/incremental_time_full_walkthrough/) to learn how to use SQLMesh in a full walkthrough.

docs/cloud/tcloud_getting_started.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Technical Requirements:
3737

3838
- Tobiko Cloud requires Python version between 3.9 and 3.12
3939

40-
??? "Installing Python"
40+
!!! note
4141
If you don't have a supported Python version installed, you can use [uv](https://docs.astral.sh/uv/getting-started/installation/#installation-methods) to install it.
4242
At the time of writing, these are the suggested commands to install uv and Python:
4343

@@ -104,7 +104,15 @@ First, open a terminal within your terminal/IDE (ex: VSCode). Then follow the fo
104104
!!! note
105105
You may need to run `python3` or `pip3` instead of `python` or `pip`, depending on your python installation.
106106

107-
4. Create an alias to ensure use of `tcloud`:
107+
If you do not see `tcloud` in the virtual environment path above, you may need to reactivate the venv:
108+
109+
```bash
110+
source .venv/bin/activate
111+
which tcloud
112+
# expected path: /Users/person/Desktop/git_repos/tobiko-cloud-demo/.venv/bin/tcloud
113+
```
114+
115+
- Create an alias to ensure use of `tcloud`:
108116

109117
We recommend using a command line alias to ensure all `sqlmesh` commands run on Tobiko Cloud.
110118

@@ -214,6 +222,7 @@ Now we're ready to connect your data warehouse to Tobiko Cloud:
214222
cicd_bot:
215223
type: github
216224
merge_method: squash
225+
skip_pr_backfill: false
217226
enable_deploy_command: true
218227
auto_categorize_changes:
219228
external: full
@@ -223,7 +232,7 @@ Now we're ready to connect your data warehouse to Tobiko Cloud:
223232
224233
# preview data for forward only models
225234
plan:
226-
enable_preview: true
235+
enable_preview: true
227236
228237
# list of users that are allowed to approve PRs for synchronized deployments
229238
users:

docs/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -135,14 +135,16 @@ Install SQLMesh through [pypi](https://pypi.org/project/sqlmesh/) by running:
135135
```bash
136136
mkdir sqlmesh-example
137137
cd sqlmesh-example
138-
139-
python -m venv .env
140-
source .env/bin/activate
141-
138+
python -m venv .venv
139+
source .venv/bin/activate
142140
pip install sqlmesh
141+
source .venv/bin/activate # reactivate the venv to ensure you're using the right installation
143142
sqlmesh init duckdb # get started right away with a local duckdb instance
143+
sqlmesh plan # see the plan for the changes you're making
144144
```
145145

146+
> Note: You may need to run `python3` or `pip3` instead of `python` or `pip`, depending on your python installation.
147+
146148
Follow the [quickstart guide](https://sqlmesh.readthedocs.io/en/stable/quickstart/cli/#1-create-the-sqlmesh-project) to learn how to use SQLMesh. You already have a head start!
147149

148150
Follow this [example](https://sqlmesh.readthedocs.io/en/stable/examples/incremental_time_full_walkthrough/) to learn how to use SQLMesh in a full walkthrough.

0 commit comments

Comments
 (0)