Dbt: Add a Function to Allow Easy Hyperlinking Between Model Documentation
Function to Allow Easy Hyperlinking Between Model Documentation
Feature description
Right now, if you are writing a doc block for a model and want to embed a hyperlink to a different doc block, it is necessary to do syntax like this: [link text][link title](#!/model/model.package.model_name). This is a bit clunky and difficult to follow. It would be nice to have a function like "link(model_name)" to make it easier to embed hyperlinks to other models in documentation.
Who will this benefit?
All users who want to be able to construct links between various documentation pages for models when using the "dbt docs" functionality.
jrandrews
All 5 comments
Really great idea! I think this should be relatively straightforward for someone to add to dbt -- going to add a Good first issue label here. Happy to help out anyone who wants to take a stab at it!
drewbanin
on 5 Mar 2019
In addition, it would be nice to have the ability to have SQL queries executed and have their output actually appear in dbt docs. One use case could be including a line of documentation that says "The earliest record in X table has a timestamp of XXXXXXX" and have the value of the timestamp populated at runtime. Or have an aggregate query execute to count the number of transaction values by a certain lookup value, e.g. cars by color, and then have a table get populated in the documentation output to actually display what this looks like in the database.
jrandrews
on 12 Mar 2019
Tentatively pulling this issue in the wilt-chamberlain release, pending questions about what sort of dbt context we can provide in the docs blocks. See also: https://github.com/fishtown-analytics/dbt/issues/1255
drewbanin
on 3 May 2019
Kicking this one out of Wilt Chamberlain, but excited to tackle it for a subsequent release! Just prioritized for Louisa May Alcott, which should be the first feature release after 0.14.0 (so, either 0.14.x, or 0.15.0, depending)
drewbanin
on 3 Jun 2019
related to #1503
cmcarthur
on 25 Sep 2019
Related issues
whittid4
路
3Comments
chrisburrell
路
3Comments
drewbanin
路
3Comments
nave91
路
3Comments
drewbanin
路
3Comments
Most helpful comment
In addition, it would be nice to have the ability to have SQL queries executed and have their output actually appear in dbt docs. One use case could be including a line of documentation that says "The earliest record in X table has a timestamp of XXXXXXX" and have the value of the timestamp populated at runtime. Or have an aggregate query execute to count the number of transaction values by a certain lookup value, e.g. cars by color, and then have a table get populated in the documentation output to actually display what this looks like in the database.