Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update readme with docs site link and PR template #179

Merged
merged 2 commits into from
Oct 22, 2024
Merged

chore: update readme with docs site link and PR template #179

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
229753d
chore: update readme with docs site link
andrablaj Oct 22, 2024
4258a45
update PR template
andrablaj Oct 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/pull_request_template.md
View file
Open in desktop
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
View file
Open in desktop
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
Loading