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

Rework CLI installation docs #638

Merged
merged 6 commits into from
Nov 15, 2021
Merged

Rework CLI installation docs #638

merged 6 commits into from
Nov 15, 2021

Conversation

jtcohen6
Copy link
Collaborator

@jtcohen6 jtcohen6 commented Apr 17, 2021

Now updated for v1!

This rework is motivated by a few frequent questions / sources of confusion in the community:

  • Installing the "standard distribution" of dbt vs. installing just one adapter
  • Python compatibility of some adapters
  • Prerequisites for pip installations on certain operating systems (e.g. Improve pre-installation instructions #606), including M1 mac compatibility
  • (In v1) Removed support for pip install dbt, in favor of adapter-specific installation

Also:

  • Added Docker as an official installation method—but since we're changing the details for v1, leave at "more coming soon" for now
  • Split up into multiple pages (I know this is a reversion to how things used to be! but I think this page is getting too long...)
  • Moved specific-and-verbose instructions / suggestions into FAQs
  • Rename dbt Cloud on-prem installation page so that it doesn't confuse users who search "install"

Pre-release docs

Is this change related to an unreleased version of dbt?

  • Yes: please
    • update the base branch to next
    • add Changelog components: <Changelog>[New/Changed] in v0.x.0</Changelog>
    • add links to the "New and changed documentation" section of the latest [Migration Guide]

Checklist

If you added new pages (delete if not applicable):

  • The page has been added to website/sidebars.js
  • The new page has a unique filename

If you removed existing pages (delete if not applicable):

  • The page has been removed from website/sidebars.js
  • An entry has been added to _redirects

@drewbanin
Copy link
Collaborator

thanks for doing this @jtcohen6! Removing myself from review, but please feel free to tag me on anything in particular that you'd like my eyes on!

@jtcohen6
Copy link
Collaborator Author

jtcohen6 commented Oct 2, 2021

I'm back! Repurposing this branch/PR to reflect updates to plugins and installation in the lead-up to v1.0.0-b1

@jtcohen6 jtcohen6 force-pushed the prerelease/1-0-0-b1 branch from c92eeb9 to 6bfcc00 Compare October 13, 2021 10:12
Base automatically changed from prerelease/1-0-0-b1 to next October 13, 2021 18:14
@jtcohen6 jtcohen6 force-pushed the rework/cli-installation branch from e6b9cf1 to 1ddc1f9 Compare November 8, 2021 11:34
@jtcohen6 jtcohen6 requested review from runleonarun and joellabes and removed request for clrcrl and annafil November 8, 2021 11:40
@jtcohen6 jtcohen6 force-pushed the rework/cli-installation branch from 1ddc1f9 to a4d657f Compare November 8, 2021 11:40
Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

Looking good! As I got further through and suggested more and more capital Ps, I got worried that there is semantic meaning to Python vs python in prose. Hopefully not though!

title: "Homebrew"
---

dbt Labs maintains Homebrew formulae for the four oldest and most popular adapter plugins.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
dbt Labs maintains Homebrew formulae for the four oldest and most popular adapter plugins.
dbt Labs maintains Homebrew formulae for the four oldest and most popular adapter plugins: Postgres, Redshift, Snowflake, and BigQuery.

@jtcohen6
Copy link
Collaborator Author

@joellabes Thank you for taking a look, and for the spot-on feedback!

@jtcohen6 jtcohen6 requested a review from joellabes November 10, 2021 14:30
Copy link
Contributor

@joellabes joellabes left a comment

Choose a reason for hiding this comment

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

Two tweaks, one question, then LGTM!

@jtcohen6 jtcohen6 merged commit 6fd1e1b into next Nov 15, 2021
mirnawong1 pushed a commit that referenced this pull request Sep 30, 2024
REPO SYNC - Public to Private
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants