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.

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

Update pip install instructions in semantic-layer-2-setup.md #4009

Merged
merged 1 commit into from
Sep 4, 2023

Conversation

tromsky
Copy link
Contributor

@tromsky tromsky commented Sep 2, 2023

Adding double-quotes around the module name and extra information in installation command to help guarantee success

What are you changing in this pull request and why?

In the installation instructions for Metricflow here, the instructions state:

source [virtual environment name]/bin/activate
# install dbt and MetricFlow
pip install dbt-metricflow[adapter name]
# e.g. dbt-metricflow[snowflake]
image

However, thesyntax for pip installation instructions with optional extras should wrap the module and extras in double quotes:

pip install "dbt-metricflow[adapter name]"

This is guaranteed to run successfully, while the version without quotes may not.

This also follows the convention in the Metricflow tutorial README.md here

image

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):

  • Remove page from website/sidebars.js
  • Add an entry website/static/_redirects
  • Ran link testing to update the links that point to the deleted page

Adding double-quotes around the module name and extra information in installation command to help guarantee success
@tromsky tromsky requested a review from a team as a code owner September 2, 2023 10:09
@welcome
Copy link

welcome bot commented Sep 2, 2023

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

@netlify
Copy link

netlify bot commented Sep 2, 2023

Deploy Preview for docs-getdbt-com ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 978b765
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64f309f59da6ff00084213fd
😎 Deploy Preview https://deploy-preview-4009--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added new contributor Label for first-time contributors content Improvements or additions to content guides Knowledge best suited for Guides size: x-small This change will take under 3 hours to fix. and removed new contributor Label for first-time contributors labels Sep 2, 2023
Copy link
Contributor

@mirnawong1 mirnawong1 left a comment

Choose a reason for hiding this comment

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

hey @tromsky thanks for opening this pr up and spot on! it also aligns with the dedicated metricflow cli doc here - appreciate you opening this up to fix this!

@mirnawong1 mirnawong1 merged commit b6d7e97 into dbt-labs:current Sep 4, 2023
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content guides Knowledge best suited for Guides size: x-small This change will take under 3 hours to fix.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants