Skip to content

Commit

Permalink
Merge pull request #127 from cagov/updating_docs
Browse files Browse the repository at this point in the history
small edits to the setup and writing documentation docs
  • Loading branch information
ian-r-rose authored May 31, 2023
2 parents f4dc378 + a949f75 commit 99e2ed1
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
20 changes: 18 additions & 2 deletions docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,9 @@ This will depend on your operating system and shell. For Linux and Mac OS system
as well as users of Windows subsystem for Linux (WSL) it's often set in
`~/.zshrc`, `~/.bashrc`, or `~/.bash_profile`.

If you use zsh or bash, open your shell configuration file, and add the lines:
If you use zsh or bash, open your shell configuration file, and add the following lines:

**Default Transformer role**

```bash
export SNOWFLAKE_ACCOUNT=<account-locator>
Expand All @@ -83,7 +85,21 @@ export SNOWFLAKE_ROLE=TRANSFORMER_DEV
export SNOWFLAKE_WAREHOUSE=TRANSFORMING_XS_DEV
```

Then open a new-terminal and verify that the environment variables are set.
This will enable you to perform transforming activities which is needed for dbt.
Open a new terminal and verify that the environment variables are set.

**Switch to Loader role**

```bash
export SNOWFLAKE_ACCOUNT=<account-locator>
export SNOWFLAKE_USER=<your-username>
export SNOWFLAKE_PASSWORD=<your-password>
export SNOWFLAKE_ROLE=LOADER_DEV
export SNOWFLAKE_WAREHOUSE=LOADING_XS_DEV
```

This will enable you to perform loading activities and is needed to which is needed for Airflow or Fivetran.
Again, open a new terminal and verify that the environment variables are set.

## Configure AWS and GCP (optional)

Expand Down
8 changes: 1 addition & 7 deletions docs/writing-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,7 @@ and are authored using [markdown](https://docs.github.com/en/get-started/writing
## Local Development

To write documentation for this project, make sure that the build tools are installed.
In a Python environment run:

```bash
python -m pip install -r requirements-docs.txt
```

You should then be able to start a local server for the docs:
In a Python environment and in the data-infrastructure repo, you should be able to start a local server for the docs by running:

```bash
mkdocs serve
Expand Down

0 comments on commit 99e2ed1

Please sign in to comment.