From 9c028e9fba7f26ada670f9783af75cb501b8a72a Mon Sep 17 00:00:00 2001
From: Drew Banin <drew@fishtownanalytics.com>
Date: Mon, 20 Aug 2018 22:00:57 -0400
Subject: [PATCH] (fixes #941) Create default overview block for docs website

---
 MANIFEST.in                                 |  2 +-
 dbt/include/global_project/dbt_project.yml  |  1 +
 dbt/include/global_project/docs/overview.md | 43 +++++++++++++++++++++
 setup.py                                    |  1 +
 4 files changed, 46 insertions(+), 1 deletion(-)
 create mode 100644 dbt/include/global_project/docs/overview.md

diff --git a/MANIFEST.in b/MANIFEST.in
index e2c92d45dcc..9e5b4e09e7c 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -1 +1 @@
-recursive-include dbt/include *.py *.sql *.yml *.html
+recursive-include dbt/include *.py *.sql *.yml *.html *.md
diff --git a/dbt/include/global_project/dbt_project.yml b/dbt/include/global_project/dbt_project.yml
index cf30f7f9184..87bfe0dd8eb 100644
--- a/dbt/include/global_project/dbt_project.yml
+++ b/dbt/include/global_project/dbt_project.yml
@@ -2,4 +2,5 @@
 name: dbt
 version: 1.0
 
+docs-paths: ['docs']
 macro-paths: ["macros"]
diff --git a/dbt/include/global_project/docs/overview.md b/dbt/include/global_project/docs/overview.md
new file mode 100644
index 00000000000..b07ea31610a
--- /dev/null
+++ b/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 %}
diff --git a/setup.py b/setup.py
index 03b0d28cccd..aa72e66a630 100644
--- a/setup.py
+++ b/setup.py
@@ -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',