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

Nfiann-prerelease #6502

Open
wants to merge 17 commits into
base: current
Choose a base branch
from
Open

Nfiann-prerelease #6502

wants to merge 17 commits into from

Conversation

nataliefiann
Copy link
Contributor

@nataliefiann nataliefiann commented Nov 18, 2024

What are you changing in this pull request and why?

I've created this PR following Git issue: #2144 This is one of two PRs - the second will be a new doc

This PR provides users with instructions on installing pre-releases.

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."
  • The content in this PR requires a dbt release note, so I added one to the release notes page.

🚀 Deployment available! Here are the direct links to the updated files:

@nataliefiann nataliefiann requested a review from a team as a code owner November 18, 2024 21:06
Copy link

vercel bot commented Nov 18, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Dec 19, 2024 9:30am

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address labels Nov 18, 2024

</Expandable>

If you’re using a different operating system, refer to [Git issue on Instructions to create a python virtual environment](https://github.com/dbt-labs/docs.getdbt.com/discussions/2143) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

i know i mentioned linking to the github issue but maybe it's more direct to link them to the repo which has the toggles?

maybe that's more of a doug question to confirm?

Copy link
Contributor

Choose a reason for hiding this comment

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

Rather than link to a GitHub Discussion or repo, I think we should either:

  1. exclude the instructions and exclude the links
  2. explicitly include the instructions for other operating system shells

Comment on lines 196 to 201
These commands will install the prerelease:

```shell
python3 -m pip install --upgrade pip
python3 -m pip --version
pip 23.3.1 from .../.venv/lib/python3.9/site-packages (python 3.9)
Copy link
Contributor

Choose a reason for hiding this comment

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

The first two commands look like they will upgrade the install of pip and then verify the version. The last line is the output rather than a command itself.

Recommendation is to either cut this section entirely or to update it.

Comment on lines 213 to 219
These commands will install the prerelease:

```shell
py -m pip install --upgrade pip
py -m pip --version
pip 23.3.1 from .venv\lib\site-packages (Python 3.9.4)
```
Copy link
Contributor

Choose a reason for hiding this comment

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

python3 -m venv venv
source venv/bin/activate
python3 -m pip install --upgrade pip
python3 -m pip install --pre dbt-core dbt-adapter-name
Copy link
Contributor

Choose a reason for hiding this comment

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

This is the key part, and it looks good 👍

python3 -m pip install --pre dbt-core dbt-adapter-name

Note: it will also install any pre-releases of all dependencies.

@nataliefiann
Copy link
Contributor Author

Querying commands for operating systems here: https://dbt-labs.slack.com/archives/C05FWBP9X1U/p1732882329473009

```
Note, this will also install any pre-releases of all dependencies.

#### Install prereleases of dbt-adapters on different operating systems
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.SentenceCaseHeaders] 'Install prereleases of dbt-adapters on different operating systems' should use sentence-style capitalization. Try 'Install prereleases of dbt adapters on different operating systems' instead.


### Install prereleases of dbt-adapters

dbt-adapters are only compatible with dbt Core 1.8+. If you are on dbt Core v1.7 or below, follow the steps to upgrade to v1.8+ to install prereleases of dbt-adapters.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.7'?


### Install prereleases of dbt-adapters

dbt-adapters are only compatible with dbt Core 1.8+. If you are on dbt Core v1.7 or below, follow the steps to upgrade to v1.8+ to install prereleases of dbt-adapters.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[custom.Typos] Oops there's a typo -- did you really mean 'v1.8+'?

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 size: medium This change will take up to a week to address
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants