Skip to content

Commit

Permalink
(fixes #941) Create default overview block for docs website
Browse files Browse the repository at this point in the history
  • Loading branch information
drewbanin committed Aug 23, 2018
1 parent 1a1d45c commit 2d91be0
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
2 changes: 1 addition & 1 deletion MANIFEST.in
@@ -1 +1 @@
recursive-include dbt/include *.py *.sql *.yml *.html
recursive-include dbt/include *.py *.sql *.yml *.html *.md
1 change: 1 addition & 0 deletions dbt/include/global_project/dbt_project.yml
Expand Up @@ -2,4 +2,5 @@
name: dbt
version: 1.0

docs-paths: ['docs']
macro-paths: ["macros"]
43 changes: 43 additions & 0 deletions dbt/include/global_project/docs/overview.md
@@ -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 %}
1 change: 1 addition & 0 deletions setup.py
Expand Up @@ -24,6 +24,7 @@ def read(fname):
'dbt': [
'include/index.html',
'include/global_project/dbt_project.yml',
'include/global_project/docs/*.md',
'include/global_project/macros/*.sql',
'include/global_project/macros/**/*.sql',
'include/global_project/macros/**/**/*.sql',
Expand Down

0 comments on commit 2d91be0

Please sign in to comment.