-
Notifications
You must be signed in to change notification settings - Fork 86
Closed
Labels
bugSomething isn't workingSomething isn't working
Description
Describe the bug
Package level overviews from packages imported into a project are not correctly being loaded and rendered in the generated docs sites, instead the default overview is being used. This used to be served on any imported packages. It still works if you copy them to your project level, but this is not standard behaviour.
Steps To Reproduce
- Create a dbt project
- Create and add the following to
packages.ymlpackages: - package: snowplow/snowplow_web version: 0.13.2
- Run
dbt depsthendbt docs generatethendbt docs serve - Click on the Snowplow_web folder on the left, it will contain the default welcome message
- Copy the
dbt_packages/snowplow_web/docs/markdown/snowplow_web_overview.mdfile tomodels/snowplow_web_overview.mdand re-rundbt docs generate - Refresh the served page (maybe not required), the snowplow web overview is now rendered
-
- (Optional) Delete the file you added and re-generate and refresh, overview is gone
- (Optional) Alternatively, you can delete the specific
doc.<your_project_name>.__snowplow_web__from the manifest and see the change, note thatdoc.snowplow_web.__snowplow_web__also exists and should be being rendered.
Expected behavior
The markdown is rendered without needing to copy the file to the project level
Screenshots and log output
The output of dbt --version:
Core:
- installed: 1.4.4
- latest: 1.4.4 - Up to date!
Plugins:
- databricks: 1.4.2 - Up to date!
- bigquery: 1.4.1 - Up to date!
- snowflake: 1.4.1 - Up to date!
- redshift: 1.4.0 - Up to date!
- postgres: 1.4.4 - Up to date!
- spark: 1.4.1 - Up to date!
Additional context
Related to https://github.com/dbt-labs/dbt-docs/pull/367/files, my guess is it's related to the following line
dbt-docs/src/app/overview/index.js
Line 27 in 74bcf94
| selected_overview = project.docs[`${project_name}.__${project_name}__`] || selected_overview |
which maybe needs to be changed to
selected_overview = project.docs[`doc.${project_name}.__${project_name}__`] || selected_overviewReactions are currently unavailable
Metadata
Metadata
Assignees
Labels
bugSomething isn't workingSomething isn't working