Skip to content

Commit

Permalink
chore: update readme with docs site link and PR template (#179)
Browse files Browse the repository at this point in the history
  • Loading branch information
andrablaj authored Oct 22, 2024
1 parent af1cf8d commit bf60640
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Description

[description]
<!-- DESCRIPTION -->

medic/pipeline#[number]
<!-- ISSUE NUMBER -->

# Code review checklist
<!-- Remove or comment out any items that do not apply to this PR; in the remaining boxes, replace the [ ] with [x]. -->
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
A set of SQL queries that transform raw CouchDB data into a more useful format. It uses `dbt` to define the models that are translated into PostgreSQL tables or views, which makes it easier to query the data in the analytics platform of choice.
A set of SQL queries that transform raw CouchDB data into a more useful format for analytics. It uses `dbt` to define the models that are translated into PostgreSQL tables or views, which makes it easier to query the data in the analytics platform of choice.

## Local Setup
Follow the instructions in [the Local CHT Sync Setup documentation](https://docs.communityhealthtoolkit.org/apps/guides/data/analytics/setup/) to set up CHT Sync locally.
## Setup
Follow the instructions in [the CHT Sync documentation](https://docs.communityhealthtoolkit.org/hosting/analytics/) to set up the data pipeline.

## Run dbt models unit tests locally

Expand All @@ -11,7 +11,7 @@ Follow the instructions in [the Local CHT Sync Setup documentation](https://docs
### Run the tests

1. Navigate to `tests` folder.
2. Run the test script
2. Run the test script:

```sh
# set environment variables, install dbt dependencies, seed data, run dbt, run test
Expand Down

0 comments on commit bf60640

Please sign in to comment.