Implemented individual overview functionality. #129
Conversation
|
this is really neat @Mr-Nobody99!! I think we'll need to re-compile the artifacts in the I largely feel pretty good about an approach like this, but I'm tagging @jtcohen6 to see if he has any additional thoughts. I imagine a good scheme being Nice work! |
|
Thank you much @drewbanin, glad to hear that, I look forward to any input @jtcohen6 has as well. I also went ahead and changed the naming format to __{{ project_name }}__ as you suggested. |
There was a problem hiding this comment.
This is a great idea! Thanks for the thoughtful work @Mr-Nobody99, I left one comment about overviews for installed packages.
src/app/overview/index.js
Outdated
| if (overview.package_name != 'dbt') { | ||
| selected_overview = overview; | ||
| } | ||
| }); | ||
|
|
||
| if (project_name !== null) { | ||
| let project_key = `${project_name}.__${project_name}__`; |
There was a problem hiding this comment.
I think we'll want to let top-level projects "override" the project-level overviews of installed packages. If my_project installs the snowplow package, I would want my_project.__snowplow__ to take precedence over snowplow.__snowplow__, especially if the latter doesn't exist.
There was a problem hiding this comment.
Thanks a lot @jtcohen6 I'm glad you like the idea, I agree with your comment completely. I added a new commit that I think should handle that scenario. Let me know if you think it needs any other change.
… that package level if possible.
There was a problem hiding this comment.
This looks great! I just formalized the contribution process for this repo, in line with the process in the main dbt repo. Could you:
- Add an entry to
CHANGELOG.mdunderdbt 0.18.0 (Release TBD)describing the change (linking Individual project overviews #127 + Implemented individual overview functionality. #129), and add yourself to a new list of contributors - Sign our CLA, if you haven't already
|
|
||
| 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 %} |
There was a problem hiding this comment.
- Could you add an entry for
{% docs __dbt_utils__ %}below? - As Drew mentioned, to really see your change in the PR preview, we'll need to run
dbt docs generatein theci-projectto replace the artifacts currently indata/. If you're up for doing this as part of this PR, great! If not, we can do it separately after merging.
There was a problem hiding this comment.
@jtcohen6 Thanks for the suggestion I added a block for dbt_utils. I also generated docs in the ci-project and replaced the data/ files with them. I also signed the CLA. Please let me know if I did anything incorrectly with the data/ artifacts.
|
@cla-bot check |
|
Thanks for your pull request, and welcome to our community! We require contributors to sign our Contributor License Agreement and we don't seem to have your signature on file. Check out this article for more information on why we have a CLA. In order for us to review and merge your code, please submit the Individual Contributor License Agreement form attached above above. If you have questions about the CLA, or if you believe you've received this message in error, don't hesitate to ping @drewbanin. CLA has not been signed by users: @Mr-Nobody99 |
|
The cla-bot has been summoned, and re-checked this pull request! |
…oject(replaced existing in data/)
…s in ci_project and replaced data/
…om ci_project(replaced existing in data/)" This reverts commit b2999b6.
ci-project/models/overview.md
Outdated
| <<<<<<< HEAD | ||
| 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. | ||
| ======= | ||
| and giving it a name with the following convention __<project_name>__. | ||
| >>>>>>> parent of b2999b6... Added overview block for dbt_utils, and generated new docs from ci_project(replaced existing in data/) |
There was a problem hiding this comment.
Tiny thing: looks like there are a few git vestiges from merging
There was a problem hiding this comment.
Ah my bad, next commit should fix.
The primary changes are to the routing (added a new route for project_overviews),
and the model tree (added a condition to the click event to route to project overview),
I also added an example docs block in the ci-project/models/README.md
I made the changes in such a way that if there are no project level overview block defined default functionality should be unaffected. (ie. display overview block as normal.)
Fixes #127