-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(fixes #941) Create default overview block for docs website
- Loading branch information
Showing
4 changed files
with
46 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
recursive-include dbt/include *.py *.sql *.yml *.html | ||
recursive-include dbt/include *.py *.sql *.yml *.html *.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,4 +2,5 @@ | |
name: dbt | ||
version: 1.0 | ||
|
||
docs-paths: ['docs'] | ||
macro-paths: ["macros"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
|
||
{% docs __overview__ %} | ||
|
||
### Welcome! | ||
|
||
Welcome to the auto-generated documentation for your dbt project! | ||
|
||
### Navigation | ||
|
||
You can use the `Project` and `Database` navigation tabs on the left side of the window to explore the models | ||
in your project. | ||
|
||
#### Project Tab | ||
The `Project` tab mirrors the directory structure of your dbt project. In this tab, you can see all of the | ||
models defined in your dbt project, as well as models imported from dbt packages. | ||
|
||
#### Database Tab | ||
The `Database` tab also exposes your models, but in a format that looks more like a database explorer. This view | ||
shows relations (tables and views) grouped into database schemas. Note that ephemeral models are _not_ shown | ||
in this interface, as they do not exist in the database. | ||
|
||
### Graph Exploration | ||
You can click the blue icon on the bottom-right corner of the page to view the lineage graph of your models. | ||
|
||
On model pages, you'll see the immediate parents and children of the model you're exploring. By clicking the `Expand` | ||
button at the top-right of this lineage pane, you'll be able to see all of the models that are used to build, | ||
or are built from, the model you're exploring. | ||
|
||
Once expanded, you'll be able to use the `--models` and `--exclude` model selection syntax to filter the | ||
models in the graph. For more information on model selection, check out the [dbt docs](https://docs.getdbt.com/reference#section-specifying-models-to-run). | ||
|
||
Note that you can also right-click on models to interactively filter and explore the graph. | ||
|
||
--- | ||
|
||
### More information | ||
|
||
- [What is dbt](https://docs.getdbt.com/docs/overview)? | ||
- Read the [dbt viewpoint](https://docs.getdbt.com/docs/viewpoint) | ||
- [Installation](https://docs.getdbt.com/docs/installation) | ||
- Join the [chat](https://slack.getdbt.com/) on Slack for live questions and support. | ||
|
||
{% enddocs %} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters