Fix version orders #6057

JKarlavige · 2024-09-12T15:41:25Z

What are you changing in this pull request and why?

Issue

With the current versioning, v1.10 is considered less than v1.9. This adjusts the versioning to correctly sort the version numbers by major, minor and patch versions.

Preview

Verify the VersionBlock components correctly show/hide based on the firstVersion & lastVersion props set:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/docs/version-testing

Verify this page hides from the sidebar for versions after v1.8:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/resource-configs/target_database

Verify Project configs sidebar category is only visible for v1.8 and up:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/dbt_project.yml

To quickly test the new sortVersions method, drop the following code into the versionBlock file and visit the /version-testing page above. There is a console.log within sortVersions which will show the sorted array of versions.

sortVersions([
  "1.11",
  "1.7",
  "2.1",
  "1.8",
  "1.6",
  "2.2.1",
  "1.10",
  "2.0.1",
  "1.9",
  "1.9.1",
  "1.10.1",
  "2.0",
]);

TODO Before Merge

Delete demo version-testing page
Remove console.log from sortedVersions
Revert versions in dbt-versions
Remove demo Project configs versioned category in dbt-versions

vercel · 2024-09-12T15:41:28Z

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

Name	Status	Preview	Updated (UTC)
docs-getdbt-com	✅ Ready (Inspect)	Visit Preview	Sep 17, 2024 2:25pm

JKarlavige · 2024-09-12T17:31:52Z

contributing/single-sourcing-content.md

Functionality not used, confirmed with Docs team we can remove the Var component: https://dbt-labs.slack.com/archives/C02NCQ9483C/p1726157412409069

JKarlavige · 2024-09-12T18:30:41Z

website/dbt-versions.js

+    "page": "reference/resource-configs/target_database",
    "lastVersion": "1.8",
  },
  {
-    "page": "/reference/resource-configs/target_schema",
+    "page": "reference/resource-configs/target_schema",


Keep these changes, page paths should not have leading forward slash. Remove all other changes in this file.

JKarlavige · 2024-09-12T18:30:58Z

website/docs/docs/version-testing.md

Delete this page before merge

JKarlavige · 2024-09-12T18:33:53Z

website/src/utils/sort-versions.js

+    return 0
+  });
+
+  console.log('sortedVersions', sortedVersions)


Remove this console before merge

john-rock · 2024-09-13T18:02:38Z

Hey @JKarlavige nice work on this, qq on this page https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/resource-configs/target_database

Confirmed it does get hidden from the sidebar after v1.8 but is this the correct copy that is suppose to be showing if the page is accessed when the version is set > v1.8?

Specifically the "You should upgrade to 0 or later if you want to use this feature."

JKarlavige · 2024-09-13T18:13:54Z

Hey @JKarlavige nice work on this, qq on this page https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/resource-configs/target_database

Confirmed it does get hidden from the sidebar after v1.8 but is this the correct copy that is suppose to be showing if the page is accessed when the version is set > v1.8?

Specifically the "You should upgrade to 0 or later if you want to use this feature."

Nice catch, it should definitely not say that. Will work on fixing that!

Co-authored-by: Ly Nguyen <[email protected]>

Adds a reference to `{{ target.schema }}`, useful when defining `foreign_key` constraints.

## What are you changing in this pull request and why? Reorganized the Advanced CI docs ## Checklist - [x] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines. - [x] Needs PM review - [x] Needs Legal review --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: nataliefiann <[email protected]>

## What are you changing in this pull request and why? Fix card on landing page ## Checklist - [x] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) so my content adheres to these guidelines. - [x] The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the [version a whole page](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-of-content) guidelines.

dbt-core 1.8.3 release

## What are you changing in this pull request and why? * Updating to our own dbt maintained repo. Note that Leah will update the videos next week. ## Checklist - [ ] I have reviewed the [Content style guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md) 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](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version) and/or [version a block of content](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-blocks-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."

adding per feedback: https://dbt-labs.slack.com/archives/C06GJRK27PF/p1726261331100539?thread_ts=1726163198.724299&cid=C06GJRK27PF

JKarlavige · 2024-09-16T14:23:03Z

@john-rock Updated the version warning banner to exclude the "first available in version.." part of the message if a firstVersion prop isn't set for that versioned page. Previews below:

Verify version banner no longer shows incorrect upgrade recommendation line:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/resource-configs/target_database

Select v1.7 or lower and verify version banner shows with correct message:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/reference/global-configs/indirect-selection

Verify all pages not listed in versionedPages array do not show version warning banner:
https://docs-getdbt-com-git-fix-version-orders-dbt-labs.vercel.app/docs/introduction

john-rock

This lgtm. I'm no longer seeing the incorrect warning message if firstVersion is not set.

john-rock · 2024-09-16T20:17:29Z

website/src/utils/sort-versions.js

+    const aMajor = aSegments[0] || "0"
+    const bMajor = bSegments[0] || "0"
+    const aMinor = aSegments[1] || "0"
+    const bMinor = bSegments[1] || "0"
+    const aPatch = aSegments[2] || "0"
+    const bPatch = bSegments[2] || "0"


The lengths we go to with javascript 🤣 nice work on this util.

JKarlavige added 5 commits September 11, 2024 14:17

add method to sort versions and begin adding to versionBlock component

2964275

revert changes to cumulative-metrics page

2c6d652

sortVersions method working

779b415

update versionBlock version handling

bd4419d

update page-version-check

275bd32

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

vercel bot deployed to Preview September 12, 2024 15:42 View deployment

JKarlavige added 4 commits September 12, 2024 11:51

create util to handle version check

8187bd2

update page-version-check to use util version check

232566c

update category-version-check to use version check util

5a41120

remove custom variable component and variable file

710cfd8

github-actions bot added size: large This change will more than a week to address and might require more than one person and removed size: medium This change will take up to a week to address labels Sep 12, 2024

vercel bot deployed to Preview September 12, 2024 17:31 View deployment

JKarlavige commented Sep 12, 2024

View reviewed changes

website/docs/docs/version-testing.md Outdated

Copy link

Collaborator Author

JKarlavige Sep 12, 2024

Choose a reason for hiding this comment

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

Delete this page before merge

JKarlavige commented Sep 12, 2024

View reviewed changes

JKarlavige marked this pull request as ready for review September 12, 2024 18:36

JKarlavige requested a review from a team as a code owner September 12, 2024 18:36

Merge branch 'current' into fix-version-orders

3707f86

JKarlavige requested review from breezyfasano, john-rock and matthewshaver September 12, 2024 18:37

vercel bot deployed to Preview September 12, 2024 18:40 View deployment

update faq

433941c

mirnawong1 and others added 20 commits September 16, 2024 10:11

Update website/docs/faqs/Troubleshooting/auth-expired-error.md

7c2f7a1

Co-authored-by: Ly Nguyen <[email protected]>

replace w with r

9a91cfb

Update constraints.md

37fdc03

Adds a reference to `{{ target.schema }}`, useful when defining `foreign_key` constraints.

Update website/docs/reference/resource-properties/constraints.md

6791be9

Update website/docs/reference/resource-properties/constraints.md

9257248

Update configure-auto-exposures.md

80c9466

Update auto-exposures.md

35322f9

Update website/docs/docs/collaborate/auto-exposures.md

e836844

Update vertica-setup.md

b7e7940

dbt-core 1.8.3 release

Update vertica-setup.md for DBT core 1.8.5

c45db61

Update website/docs/docs/core/connect-data-platform/vertica-setup.md

4f4efd3

Update website/docs/docs/cloud-integrations/configure-auto-exposures.md

2e8b117

Update configure-auto-exposures.md

0a8bc7e

adding per feedback: https://dbt-labs.slack.com/archives/C06GJRK27PF/p1726261331100539?thread_ts=1726163198.724299&cid=C06GJRK27PF

Update website/docs/docs/cloud-integrations/configure-auto-exposures.md

c460460

Update website/docs/docs/collaborate/auto-exposures.md

e0c44d4

update version banner messaging

dfe7fd0

Merge branch 'current' into fix-version-orders

18a7e20

vercel bot deployed to Preview September 16, 2024 14:16 View deployment

remove check to always show banner if page not available

9646d9f

vercel bot deployed to Preview September 16, 2024 14:21 View deployment

john-rock approved these changes Sep 16, 2024

View reviewed changes

JKarlavige added 2 commits September 17, 2024 10:21

revert testing edits

9651162

Merge branch 'current' into fix-version-orders

24e4930

vercel bot deployed to Preview September 17, 2024 14:25 View deployment

JKarlavige merged commit 6c6a81a into current Sep 17, 2024
6 checks passed

JKarlavige deleted the fix-version-orders branch September 17, 2024 14:27

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix version orders #6057

Fix version orders #6057

JKarlavige commented Sep 12, 2024 •

edited

Loading

vercel bot commented Sep 12, 2024 •

edited

Loading

JKarlavige Sep 12, 2024 •

edited

Loading

JKarlavige Sep 12, 2024 •

edited

Loading

JKarlavige Sep 12, 2024

JKarlavige Sep 12, 2024

john-rock commented Sep 13, 2024

JKarlavige commented Sep 13, 2024

JKarlavige commented Sep 16, 2024

john-rock left a comment •

edited

Loading

john-rock Sep 16, 2024

Fix version orders #6057

Fix version orders #6057

Conversation

JKarlavige commented Sep 12, 2024 • edited Loading

What are you changing in this pull request and why?

Issue

Preview

TODO Before Merge

vercel bot commented Sep 12, 2024 • edited Loading

JKarlavige Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

JKarlavige Sep 12, 2024 • edited Loading

Choose a reason for hiding this comment

JKarlavige Sep 12, 2024

Choose a reason for hiding this comment

JKarlavige Sep 12, 2024

Choose a reason for hiding this comment

john-rock commented Sep 13, 2024

JKarlavige commented Sep 13, 2024

JKarlavige commented Sep 16, 2024

john-rock left a comment • edited Loading

Choose a reason for hiding this comment

john-rock Sep 16, 2024

Choose a reason for hiding this comment

JKarlavige commented Sep 12, 2024 •

edited

Loading

vercel bot commented Sep 12, 2024 •

edited

Loading

JKarlavige Sep 12, 2024 •

edited

Loading

JKarlavige Sep 12, 2024 •

edited

Loading

john-rock left a comment •

edited

Loading