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

Changes to docs due to 0.20/1 deprecation #2534

Merged
merged 24 commits into from
Jan 11, 2023
Merged

Changes to docs due to 0.20/1 deprecation #2534

merged 24 commits into from
Jan 11, 2023

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Dec 7, 2022

Description & motivation

This PR addresses the June 2022 deprecation of dbt Core versions 0.20 and 0.21 and has been updated to address addition of v1.4 of dbt Core
Remove versions from the version selection menu
Remove firstversion version blocks
Delete all text from lastversion version blocks that are either 0.20 or 0.21
Removed changelog notices specific to 0.20 and 0.21.
Removed extraneous leftover references to those versions (though I left the examples demonstrating upgrade processes intact).

To-do before merge

Prerelease docs

If this change is related to functionality in a prerelease version of dbt (delete if not applicable):

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
  • Run link testing to update the links that point to the deleted page

@matthewshaver matthewshaver requested a review from a team as a code owner December 7, 2022 18:40
@netlify
Copy link

netlify bot commented Dec 7, 2022

Deploy Preview for docs-getdbt-com canceled.

Name Link
🔨 Latest commit 9c8a139
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/63be0415782c370008450d72

@github-actions github-actions bot added content Improvements or additions to content guides Knowledge best suited for Guides size: large This change will more than a week to address and might require more than one person labels Dec 7, 2022
@github-actions github-actions bot removed the guides Knowledge best suited for Guides label Dec 7, 2022
Copy link
Collaborator

@jtcohen6 jtcohen6 left a comment

Choose a reason for hiding this comment

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

Thank you for this detailed & thorough work @matthewshaver!

I left a handful of comments & questions. I wouldn't consider any of them hard blockers to merging this. It might be worth surfacing to the larger group who's been involved with the work to upgrade customers to v1.0+ in Cloud this year.

@@ -109,14 +109,12 @@ You see this block when the selected version is >= 0.21:

```markdown

<VersionBlock firstVersion="0.21">
Copy link
Collaborator

Choose a reason for hiding this comment

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

Given that the purpose of this .md file is to show how to use version blocks, should we leave these in place, and just bump up the numbers? Or are there enough other examples that we should just remove entirely?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Going to leave these as I think I just got carried away. Will instead update the sample version number we used

Comment on lines -18 to -25
{
version: "0.21",
EOLDate: "2022-06-30"
},
{
version: "0.20",
EOLDate: "2022-06-30"
}
Copy link
Collaborator

Choose a reason for hiding this comment

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

👍

Comment on lines -36 to -38
:::warning ⚠️ v0.X Non-Supported Period
Accounts had until the end of June 2022 to upgrade to dbt 1.0 or later. Pre-dbt 1.0 versions will no longer receive patch fixes, and our support team will no longer assist with dbt version specific help on non-supported versions of dbt. Additionally, jobs running dbt versions prior to 1.0 may experience service disruptions before the end of the year and may be removed from the dbt Cloud context by year end. You will receive additional notification before any planned disruption to your production jobs.
:::
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is there a version of this text that we want to leave in for now, relating to pre-1.0 versions? We've been providing a lot of messaging to folks in Cloud over the course of the year, if they're using unsupported versions, but we have yet to formally remove those older versions from Cloud, or force upgrades. I don't know to what extent we still need that fact to be reflected here in the public does site.

(cc @schottj)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@jtcohen6 would it make sense to put the message back but make it about 1.0 and give a warning about the cloud versions if/when we have a solid date for deprecation?

Copy link
Collaborator

@jtcohen6 jtcohen6 Jan 11, 2023

Choose a reason for hiding this comment

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

@matthewshaver Good call. Here's a draft of an proposed update message for this page:

:::warning ⚠️ End-of-Life Versions
dbt Core versions are declared "end of life" 12 months after their initial release. This means they will receive no new updates, and that we are unable to provide the same level of ongoing support in dbt Cloud.

Jobs running "end of life" dbt Core versions may experience service disruptions. You will receive additional notification before any planned disruption to your production jobs.
:::

Meta context for our teams: For now, our focus + priority is on the very small number of accounts/customers who are still using v0.x. Once that's sorted (~March), we'll turn our attention to automating upgrades for folks who are on v1.0, given that they can most likely start using v1.1 safely, without any code changes. I don't think we need to state that in the docs explicitly, until we have a clear public date for v1.0 deprecation.

website/docs/docs/dbt-versions/core-versions.md Outdated Show resolved Hide resolved

As an example, on March 1, you may find you're using `dbt-core==1.0.3` with `dbt-snowflake==1.0.0`. The most important thing is that you're using the latest patch available for each (v1.0.x). If you're running dbt locally, you can use the `dbt --version` command to see which versions you have installed:
For example, you may find you're using `dbt-core==1.2.3` with `dbt-snowflake==1.2.0`. It is critical that you're using the latest patch available for both core and the adapter (v1.2.x). Use the `dbt --version` command to see which versions you have installed:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Good point. How should we keep these numbers up-to-date? :) I guess we could add to the release checklist for new minor versions

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will add it to the list!

@@ -27,11 +27,3 @@ $ dbt test --select source:jaffle_shop.orders
```

Yep, we know this syntax is a little less than ideal, so we're hoping to improve it in a future release. Check out the [model selection syntax](node-selection/syntax) for more examples!
Copy link
Collaborator

Choose a reason for hiding this comment

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

Yep, we know this syntax is a little less than ideal, so we're hoping to improve it in a future release.

We've had this syntax for some time, people don't seem to hate it too much :) let's remove this line

* `v0.20.0`: Test selection is no longer greedy for indirect inclusion (ALL parents must be selected for the test to be selected). It is still greedy for indirect exclusion (if ANY parent is excluded, the test is excluded).
* `v0.21.0`: Introduce `--greedy` flag (and `greedy` selector property), to optionally include tests that are indirectly selected and have an unselected parent.
* `v1.0.0`: Renamed the `--greedy` flag/property to `indirect_selection`, and set its default back to "eager" (pre-v0.20). You can achieve the "cautious" behavior introduced in v0.20 by setting the flag/property to `cautious`.
`v1.0.0`: Renamed the `--greedy` flag/property to `indirect_selection`, and set its default back to "eager" (pre-v0.20). You can achieve the "cautious" behavior introduced in v0.20 by setting the flag/property to `cautious`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

For older changelog entries like this one, where the final entries are from v1.0.0:

Does it make sense to keep this here, given that the docs site now expects you to be using at least v1.0+?

If you want to leave it in for now, and we remove when we remove v1.0 from the version list, that works too. (Not sure when exactly — it's no longer under official support, but only as of Dec 3, and lots of folks are still using it.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Adding to the March timeframe for 1.0 deprecation clean up

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds like a plan!

@@ -1,10 +1,12 @@
| dbt Core | Initial Release | Active Support Until | Critical Support Until | dbt Cloud Until | Final Patch |
| dbt Core | Initial Release | Active Support Until | Critical Support Until | dbt Cloud Until | Status |
Copy link
Collaborator

Choose a reason for hiding this comment

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

My big hesitation about the "Status" field is that it would require us to manually update this table every time we do a prerelease, final release, or hit an EOL date. That's not necessarily wrong, as long as we have it tracked in the (pre)release checklists (issues like #2427), and as long as someone has the calendar reminder for EOL dates.

Also, "GA" isn't the term we use for dbt OSS functionality. (It is for dbt Cloud functionality.) We could use "Active Support" and "Critical Support" here instead. For comparison: Python refers to this as "Maintenance status," where the analogous options are "bugfix" (= active) and "security" (= critical).

I don't mind removing the "Final Patch" column.

@matthewshaver matthewshaver added the dbt-core v1.4 Docs impact for the v1.4 release (Jan 2023) label Jan 5, 2023
@matthewshaver matthewshaver self-assigned this Jan 5, 2023
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@matthewshaver I think the code needs some {} and ,

website/dbt-versions.js Outdated Show resolved Hide resolved
website/dbt-versions.js Outdated Show resolved Hide resolved
website/dbt-versions.js Show resolved Hide resolved
matthewshaver and others added 4 commits January 10, 2023 16:25
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
Co-authored-by: Leona B. Campbell <3880403+runleonarun@users.noreply.github.com>
@jtcohen6 jtcohen6 mentioned this pull request Jan 11, 2023
2 tasks
Copy link
Collaborator

@jtcohen6 jtcohen6 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing all changes! This was a big undertaking, and you navigated it with aplomb 🎉

_Italics: Future releases, NOT definite commitments. Shown for indication only._
| dbt Core | Initial Release | Active Support Until | Critical Support Until | dbt Cloud Until |
|---------------------------------|-----------------|----------------------|-------------------------|-----------------|
| **v0.X** | (Various dates) | v1.0 release | Deprecated | Deprecated |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I was wondering if there comes a point where we should remove the line for v0.X releases, but — I decided I'd be happy to keep it here indefinitely. It concisely communicates an important piece information ("all pre-1.0 versions of dbt Core are forever deprecated")

| [**v1.1**](upgrading-to-v1.1) | Apr 28, 2022 | v1.2.0 release | Apr 28, 2023 | Apr 2023 |
| [**v1.2**](upgrading-to-v1.2) | Jul 26, 2022 | v1.3.0 release | Jul 26, 2023 | Jul 2023 |
| [**v1.3**](upgrading-to-v1.3) | Oct 12, 2022 | v1.4.0 release | Oct 12, 2023 | Oct 2023 |
| _**v1.4**_ | Jan 25, 2023 | v1.5.0 release | Jan 25, 2024 | Jan 2024 |
Copy link
Collaborator

Choose a reason for hiding this comment

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

This will want a link to the v1.4 migration guide once it exists (#2646)

@matthewshaver matthewshaver merged commit 9ba0381 into current Jan 11, 2023
@matthewshaver matthewshaver deleted the deprecation branch January 11, 2023 17:03
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 dbt-core v1.4 Docs impact for the v1.4 release (Jan 2023) size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants