Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

SL quickstart guide gives confusing advice for IDE users #5341

Closed
1 task done
joellabes opened this issue Apr 24, 2024 · 1 comment
Closed
1 task done

SL quickstart guide gives confusing advice for IDE users #5341

joellabes opened this issue Apr 24, 2024 · 1 comment
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear

Comments

@joellabes
Copy link
Contributor

joellabes commented Apr 24, 2024 •
edited
Loading

Contributions

  • I have read the contribution docs, and understand what's expected of me.

Link to the page on docs.getdbt.com requiring updates

I'm preparing for the Semantic Layer training session next week by doing the quickstart. I'm on the Test and query metrics step

What part(s) of the page would you like to see updated?

It says

dbt Cloud IDE users — Currently, running MetricFlow commands directly in the dbt Cloud IDE isn't supported, but is coming soon.

So far so good. But then that same paragraph says

You can still validate metrics using the Preview or Compile options

What does this mean? I can't run SL commands by Previewing/Compiling a scratchpad can I?

Also there's a section where it says

Validate your metrics using the Lineage tab in the IDE.

and I wouldn't use the word "validate" there either - sure it'll show them in context, but it doesn't mean that they work :thinking_face: I guess they will show an error if you have invalid code, but if that's what we're going for then I think it should be rephrased.

Additional information

Maybe it should say "the dbt Cloud IDE will show an error icon in the bottom right of the page if there is an error. You can click it to see the specific issue and resolve it."
@joellabes joellabes added content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear labels Apr 24, 2024
@mirnawong1 mirnawong1 mentioned this issue Apr 24, 2024
Merged
mirnawong1 added a commit that referenced this issue Apr 24, 2024
@mirnawong1
Correct SL guide inconsistencies (#5343)
ab6b931 
This pr seeks to update teh SL quickstart due to feedback by doing the
following:
- Clarify how users can correctly iteract with metrics via the ide.
- Updates inconsisten file path guidances for users by focusing on the
file name and not adding the directory/folder name to the guidance steps
- update snowflake partner connect location 

Resolves #5339 #5341 #5338
@mirnawong1
Copy link
Contributor

closing this as it was addressed in the PR above!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
content Improvements or additions to content improvement Use this when an area of the docs needs improvement as it's currently unclear
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@joellabes @mirnawong1