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

[Roadmap] Custom version name functionality #5974

Merged
merged 12 commits into from
Aug 28, 2024
Merged

Conversation

JKarlavige
Copy link
Collaborator

@JKarlavige JKarlavige commented Aug 26, 2024

What are you changing in this pull request and why?

Asana task

Adds a customDisplay property to the versions object to provide the option of setting a custom display name for a specific version.

For example, we can show dbt Cloud rather than v1.9 by setting the version in website/dbt-versions.js:

{
    version: "1.9",
    isPrerelease: true, 
    customDisplay: "dbt Cloud"
},

Preview

https://docs-getdbt-com-git-custom-version-name-dbt-labs.vercel.app

  • Select a different version on both desktop & mobile and verify the version updates
  • Refresh the page and verify the version persists after page reload
  • Verify the correct version banners appear after updating the version on docs pages

Notes

Disregard the v1.9 banner, this only shows because I set the customDisplay property on a version which is using isPrerelease. Confirmed with Matt they will create a separate version to use the customDisplay property which doesn't use the isPrerelease flag in prod, and the banner will not show in that scenario.

image

TODO Before Merge

  • Remove demo "dbt Cloud" version

Copy link

vercel bot commented Aug 26, 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 Aug 28, 2024 1:36pm

@JKarlavige JKarlavige changed the title Custom version name Custom version name functionality Aug 26, 2024
@github-actions github-actions bot added the size: medium This change will take up to a week to address label Aug 26, 2024
@JKarlavige JKarlavige changed the title Custom version name functionality [Roadmap] Custom version name functionality Aug 27, 2024
Copy link
Contributor

@john-rock john-rock left a comment

Choose a reason for hiding this comment

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

lgtm!

@JKarlavige JKarlavige merged commit d4af450 into current Aug 28, 2024
9 of 10 checks passed
@JKarlavige JKarlavige deleted the custom-version-name branch August 28, 2024 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants