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

add links to lifecycle pill #6845

Merged
merged 6 commits into from
Jan 30, 2025
Merged

add links to lifecycle pill #6845

merged 6 commits into from
Jan 30, 2025

Conversation

mirnawong1
Copy link
Contributor

@mirnawong1 mirnawong1 commented Jan 29, 2025

this pr adds appropriate links to the lifecycle pill and ux elements to make it a bit clearer that they're linkable.

it also centralized links using the lifecycle-url.js file and const so we can update links in one place shoudl we need to change them. this change will also apply to new and existing lifecycle pills so there aren't different UX experiences for users.

docs notion project

requested by @runleonarun and asana task for PR review requested


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

@mirnawong1 mirnawong1 requested a review from a team as a code owner January 29, 2025 10:26
Copy link

vercel bot commented Jan 29, 2025

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Jan 30, 2025 9:56am

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Jan 29, 2025
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
website/docs/docs/introduction.md Outdated Show resolved Hide resolved
@@ -5,9 +5,19 @@ pagination_next: null
pagination_prev: null
---

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 have to remove these test lifecycle pills before pr is merged

<div className={styles.header} onClick={handleToggleClick}>
<span className={`${styles.toggle} ${isOn ? styles.toggleDown : styles.toggleRight}`}></span>
&nbsp;
<span className={styles.headerText}>
{alt_header}<Lifecycle status={lifecycle} />
{alt_header}
<span onClick={(e) => e.stopPropagation()}>
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this stops the copy link propagation so that users can click the pill for the link or click on the icon to copy the url

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.

Hey @mirnawong1 this is looking good and seems to function as expected.

Just a quick question for my own curiosity.
What is the difference between Legacy and Deprecated? Just thinking in terms of a user I almost expected Legacy to be clickable and listed in the product lifecycle page .

@mirnawong1
Copy link
Contributor Author

Hey @mirnawong1 this is looking good and seems to function as expected.

Just a quick question for my own curiosity. What is the difference between Legacy and Deprecated? Just thinking in terms of a user I almost expected Legacy to be clickable and listed in the product lifecycle page .

hey @john-rock ! hm that's a good question! we have some features that are considered legacy but you can still use them if you want and the documentation isn't going anywhere -- so they're not entirely deprecated (e.g. configuring snapshots using sql config block is legacy since the new way to do it is via YAML config). whereas deprecated means its not supported and docs will be removed.

i wonder if we should add 'legacy' to the product lifecycle doc? i'll raise that with the PM team! thanks for asking such a great question!

@john-rock
Copy link
Contributor

Hey @mirnawong1 this is looking good and seems to function as expected.
Just a quick question for my own curiosity. What is the difference between Legacy and Deprecated? Just thinking in terms of a user I almost expected Legacy to be clickable and listed in the product lifecycle page .

hey @john-rock ! hm that's a good question! we have some features that are considered legacy but you can still use them if you want and the documentation isn't going anywhere -- so they're not entirely deprecated (e.g. configuring snapshots using sql config block is legacy since the new way to do it is via YAML config). whereas deprecated means its not supported and docs will be removed.

i wonder if we should add 'legacy' to the product lifecycle doc? i'll raise that with the PM team! thanks for asking such a great question!

Ah I see, thank you for the context on that!

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!

@mirnawong1
Copy link
Contributor Author

omg thank you so much @john-rock ! i really appreciate the quick review! i was a bit nervous about this one and thank you for validating!

@mirnawong1 mirnawong1 enabled auto-merge January 30, 2025 09:51
@mirnawong1 mirnawong1 merged commit 1294c98 into current Jan 30, 2025
8 checks passed
@mirnawong1 mirnawong1 deleted the clickable-lifecycle branch January 30, 2025 09:56
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 Docs team Authored by the Docs team @dbt Labs 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.

2 participants