Skip to content

Commit 2234fec

Browse files
committed
updates to the project docs naming and organization + wrote new project setup instructions for dbt cloud
1 parent cd9d622 commit 2234fec

File tree

4 files changed

+36
-560
lines changed

4 files changed

+36
-560
lines changed

docs/dbt.md

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,36 @@
11
# dbt on the Data Services and Engineering team
22

3+
## New project setup
4+
5+
To set up a new project on dbt Cloud follow these steps:
6+
7+
1. Give your new project a name.
8+
1. Click *Advanced settings* and in the *Project subdirectory* field, enter "transform"
9+
1. Select a datawarehouse connection. (e.g. Snowflake, BigQuery, Redshift)
10+
1. For the *Development credentials* section you'll want to:
11+
1. Under *Auth method* select *Key pair*
12+
1. Enter your data warehouse username
13+
1. Enter the private key amd private keypassphrase
14+
1. For more guidance, read [dbt's docs on connecting to Snowflake via key pair](https://docs.getdbt.com/docs/cloud/connect-data-platform/connect-snowflake#key-pair)
15+
1. Finally click the *Test Connection* button.
16+
1. Connect the apprioriate repository (usually GitHub). Read [dbt's docs on connecting to GitHub](https://docs.getdbt.com/docs/cloud/git/connect-github).
17+
18+
Once you're through the first five steps you can return to the dbt homepage and click the Settings button in the upper right corner. From there you can follow the steps to configure three environments for Continuous intergation - CI, development, and production. Read [dbt's docs on CI in dbt Cloud](https://docs.getdbt.com/docs/deploy/continuous-integration). Read [dbt's docs on creating production (deployment) environments](https://docs.getdbt.com/docs/deploy/deploy-environments) and [dbt's docs on creating and scheduling deploy jobs](https://docs.getdbt.com/docs/deploy/deploy-jobs#create-and-schedule-jobs).
19+
20+
You'll also want to [configure notifications for job failures](Configure notifications for job failures).
21+
22+
Pictured below is an example of environment variables you can set for each environment. For more guidance, read [dbt's docs on environment variables](https://docs.getdbt.com/docs/build/environment-variables).
23+
24+
![environment variables](images/environment_variables.png)
25+
26+
## Architecture
27+
28+
We broadly follow the architecture described in
29+
[this dbt blog post](https://www.getdbt.com/blog/how-we-configure-snowflake/)
30+
for our Snowflake dbt project.
31+
32+
It is described in more detail in our [Snowflake docs](./snowflake.md#architecture).
33+
334
## Naming conventions
435

536
Models in a data warehouse do not follow the same naming conventions as [raw cloud resources](./naming-conventions.md#general-approach),
@@ -19,14 +50,6 @@ We may adopt additional conventions for denoting aggregations, column data types
1950
If during the course of a project's model development we determine that simpler human-readable names
2051
work better for our partners or downstream consumers, we may drop the above prefixing conventions.
2152

22-
## Architecture
23-
24-
We broadly follow the architecture described in
25-
[this dbt blog post](https://www.getdbt.com/blog/how-we-configure-snowflake/)
26-
for our Snowflake dbt project.
27-
28-
It is described in more detail in our [Snowflake docs](./snowflake.md#architecture).
29-
3053
## Custom schema names
3154

3255
dbt's default method for generating [custom schema names](https://docs.getdbt.com/docs/build/custom-schemas)

docs/new-project-setup.md

Lines changed: 0 additions & 315 deletions
This file was deleted.

0 commit comments

Comments
 (0)