Implemented individual overview functionality.

CHANGELOG.md

@@ -1,4 +1,8 @@
 ## dbt 0.18.0 (Release TBD)
+- Add project level overviews ([docs#127](https://github.com/fishtown-analytics/dbt-docs/issues/127))
+
+Contributors:
+- [@Mr-Nobody99](https://github.com/Mr-Nobody99) ([docs#129](https://github.com/fishtown-analytics/dbt-docs/pull/129))
 
 ## dbt 0.18.0rc1 (August 19, 2020)
 

ci-project/models/overview.md

@@ -9,3 +9,17 @@ This [dbt](https://www.getdbt.com/) project is for demonstrations and tutorials.
 The source code can be found [here](https://github.com/clrcrl/jaffle_shop).
 
 {% enddocs %}
+
+{% docs __jaffle_shop__ %}
+## Jaffle_shop Project level overview example
+This [dbt](https://www.getdbt.com/) project may have only one project (`jaffle_shop`) currently.
+However there may be other projects included in your own projects.
+
+You can assign a unique overview for each project by adding a docs block in an .md file of your project
+and giving it a name with the following convention { \__project_name__ }
+{% enddocs %}
+
+{% docs __dbt_utils__ %}
+## DBT_UTILS package overview
+This [dbt package](https://docs.getdbt.com/docs/building-a-dbt-project/package-management) is a collection of tools to help with common tasks.
+{% enddocs %}

src/app/components/model_tree/model_tree_line.js

@@ -47,6 +47,9 @@ angular
  var source_name = item.name;
  $state.go('dbt.source_list', {source: source_name});
  }
+ else if (scope.depth === 0 && item.type !== 'database') {
+ $state.go('dbt.project_overview', { project_name: item.name });
+ }
  }
 
  scope.activate = function(item) {

src/app/index.routes.js

@@ -35,7 +35,15 @@ angular
  .state('dbt.overview', {
  url: 'overview?' + graph_params,
  controller: 'OverviewCtrl',
- templateUrl: templates.overview
+ templateUrl: templates.overview,
+ })
+ .state('dbt.project_overview', {
+ url: 'overview/:project_name?' + graph_params,
+ controller: 'OverviewCtrl',
+ templateUrl: templates.overview,
+ params: {
+ project_name: {type: 'string'}
+ }
  })
  .state('dbt.graph', {
  url: 'graph',

src/app/overview/index.js

@@ -7,21 +7,31 @@ angular
 .module('dbt')
 .controller('OverviewCtrl', ['$scope', '$state', 'project',
  function($scope, $state, projectService) {
-
  $scope.overview_md = '(loading)'
-
- projectService.ready(function(project) {
-
+
+ projectService.ready(function (project) {
+ let project_name = $state.params.project_name
+ ? $state.params.project_name
+ : null;
+
  // default;
  var selected_overview = project.docs["dbt.__overview__"];
-
  var overviews = _.filter(project.docs, {name: '__overview__'});
- _.each(overviews, function(overview) {
+ _.each(overviews, function (overview) {
  if (overview.package_name != 'dbt') {
  selected_overview = overview;
  }
  });
-
+ // Select project-level overviews
+ if (project_name !== null) {
+ selected_overview = project.docs[`${project_name}.__${project_name}__`] || selected_overview
+ let overviews = _.filter(project.docs, { name: `__${project_name}__` })
+ _.each(overviews, (overview) => {
+ if (overview.package_name !== project_name) {
+ selected_overview = overview
+ }
+ })
+ }
  $scope.overview_md = selected_overview.block_contents;
  });
 }]);