DataJunction / dj

A metrics platform.
http://datajunction.io
MIT License
35 stars 15 forks source link

Add a dictionary of links to AvailabilityState. #1214

Closed agorajek closed 4 weeks ago

agorajek commented 4 weeks ago

Summary

This feature allows to integrate our AvailabilityStates with external tools, such as data visualizations. For example... when a new availability state is added or updated, we can submit additional urls that can be shown on the Materialization tab of the node.

This PR adds:

Example: Screenshot 2024-10-24 at 10 55 16 AM

Test Plan

Deployment Plan

netlify[bot] commented 4 weeks ago

Deploy Preview for thriving-cassata-78ae72 canceled.

Name Link
Latest commit cdcd5c9db74f83af30656cbfce37ff5ca5656c51
Latest deploy log https://app.netlify.com/sites/thriving-cassata-78ae72/deploys/671be4d1cad1400008cfffbc
agorajek commented 4 weeks ago

This is awesome and is going to really unlock the seamless end to end dev flow we've been working towards. Huge thanks @agorajek. One thing I was wondering is if we should expect cases where someone wants to add links but not necessarily attach it to the materialization for a node. For example if a metric node has a doc that might be useful to link out to. I think it's enough to suggest they just put it in the metric description but just wanted to get your thoughts on that.

I think we will want to have "links" in various places. This one is specific to the Availability State / MaterializedDataset, hence I added it on that entity. In the case of other links I think we should place them as close to the proper entity as possible. Because metric nodes (an all nodes) have a description that's a good place to add a doc link, but I can see having a generic links field on the nodes as well. This way the integrations with other tools are easier to pull off.