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.

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

include directory README #4685

Merged
merged 13 commits into from
Apr 6, 2022
16 changes: 15 additions & 1 deletion core/dbt/include/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,15 @@
# Include README
# Include Module

The Include module is reponsible for housing default macro definitions, starter project scaffold, and the html file used to generate the docs page.

# Directories

## `global_project`
Defines the default implementations of jinja2 macros for `dbt-core ` which can be overwritten in each adapter repo to work more in line with those adapter plugins. to view adapter specific jinja2 changes please check the relevant adapter repos [`adapter.sql` ](https://github.com/dbt-labs/dbt-bigquery/blob/main/dbt/include/bigquery/macros/adapters.sql) file in the `include` directory or in the [`impl.py`](https://github.com/dbt-labs/dbt-bigquery/blob/main/dbt/adapters/bigquery/impl.py) file for some ex. bigquery (truncate_relation).
McKnight-42 marked this conversation as resolved.
Show resolved Hide resolved

## `starter_project`
Produces the default project after running the `dbt init` command for CLI. `dbt-cloud` initializes the project by using [dbt-starter-project](https://github.com/dbt-labs/dbt-starter-project).
McKnight-42 marked this conversation as resolved.
Show resolved Hide resolved


# Files
- `index.html` a file built using [dbt-docs](https://github.com/dbt-labs/dbt-docs) prior to new releases and replaced in the `dbt-core` directory; is used to generate the docs page after using the `generate docs` command in dbt.
McKnight-42 marked this conversation as resolved.
Show resolved Hide resolved