Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

add a doc link when vars do not exist #528

Merged
merged 3 commits into from
Apr 25, 2023

Conversation

dlawin
Copy link
Contributor

@dlawin dlawin commented Apr 25, 2023

Screenshot 2023-04-25 at 3 55 18 PM

Guide the user to https://docs.datafold.com/development_testing/open_source/#configure-your-dbt-project

For either condition:

  • no vars: section in dbt_project.yml
  • no data_diff: section in dbt_project.yml

@dlawin dlawin added enhancement New feature or request --dbt Issues/features related to the dbt integration labels Apr 25, 2023
@dlawin dlawin self-assigned this Apr 25, 2023
@leoebfolsom
Copy link
Contributor

Could we collapse it to one message?

"vars: data_diff: section not found in dbt_project.yml.\n\nTo solve this, please configure your dbt project: \n{doc_url}\n"

I'm thinking that if they lack vars:, ultimately they lack vars: data_diff:. It's just a little bit more clear to the user why they're receiving the message, and that in turn makes them more likely to click on the link.

I also think adding "To solve this" helps the user connect the directive (configure ..." to the problem ("something is missing").

@dlawin
Copy link
Contributor Author

dlawin commented Apr 25, 2023

Could we collapse it to one message?

"vars: data_diff: section not found in dbt_project.yml.\n\nTo solve this, please configure your dbt project: \n{doc_url}\n"

I'm thinking that if they lack vars:, ultimately they lack vars: data_diff:. It's just a little bit more clear to the user why they're receiving the message, and that in turn makes them more likely to click on the link.

I also think adding "To solve this" helps the user connect the directive (configure ..." to the problem ("something is missing").

@leo Done. Updated the screenshot above

Copy link
Contributor

@leoebfolsom leoebfolsom left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@dlawin dlawin merged commit cfd941f into datafold:master Apr 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
--dbt Issues/features related to the dbt integration enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants