[CT-727] Hide Package Names from Documentation

[taylorterwin]

Is this your first time opening an issue?

• I have read the expectations for open source contributors

Describe the Feature

We can disable individual models in main project but we can't do the same for an entire imported dbt package. (https://docs.getdbt.com/reference/resource-properties/docs)

Describe alternatives you've considered

No response

Who will this benefit?

No response

Are you interested in contributing this feature?

No response

Anything else?

No response

[jtcohen6]

@taylorterwin Thanks for opening!

I understand the ask here to be: Turn docs into a real node config, which can be set for multiple resources at once in dbt_project.yml, in addition to one-by-one in other project .yml files.

# dbt_project.yml
models:
  installed_package:
    # hide all models from this package in the docs
    +docs:
      show: false

I super agree! It would help with cool things like this, too: dbt-labs/dbt-docs#275

The code paths here can be a bit tricky. If there's a community member who feels interested and motivated, we might be able to support an external contribution for this.

[leahwicz]

AC: Turn docs into a real node config, with backwards compatibility for people (e.g. dbt-docs) who are accessing it as a top-level attribute (node.docs) in manifest.json

[matt-winkler]

Hey @leahwicz curious: To make this backwards compatible, we'd basically maintain the existing code which maps docs properties into their own component of the manifest.json, correct? Are there other gotchas we'd need to think about in terms of overrides / collisions between that and a docs property that lives under config?

cc @b-per and @sungchun12

[grahamcarman]

Just saw that #5397 was just merged! Is there still work to be done, though, to enable show: false at the dbt_project.yml level?

[b-per]

Even if it got merged to main it is not available to any stable release yet. I believe it will make its way to some 1.3 beta and will be in the final release of dbt 1.3 (planned for Oct if I'm correct)

[jtcohen6]

Going to close this as resolved! Will be included in the next v1.3 beta prerelease

[mkleinbort-ic]

I'm trying to use this feature, but the nodes are still appearing in my DAG by default. Is there any way to turn off specific tags or sources by default? Ie. on opening the documentation's dag the filter is excluding them.

[b-per]

Hi! docs: {show: false} is hiding individual pages for the nodes but they will still appear on the docs site in the DAG ,in another grey color, without the ability to "drill into" them.

Today it is not possible to hide nodes from the docs site DAG

[G14rb]

Hi! Sorry for the stupid and articulate question, does it mean that the "docs show" will be grey, so still visible on DAG? Correct me if I'm wrong, in this case I could exclude them but in the DAG I won't see any lineage before and after. I mean it's not possible at this stage to go from A -> B -> C and visualize just A -> C using {show: false}. Thanks

[b-per]

Yes, show: false will still show in the DAG, greyed out, without the ability to drill into the docs of the hidden model.

Today the dbt docs don't support removing models from the lineage entirely.