Closed tay1orjones closed 1 day ago
vercel[bot]
commented
4 days ago The latest updates on your projects. Learn more about Vercel for Git ↗︎
| Name | Status | Preview | Comments | Updated (UTC) |
|---|---|---|---|---|
| carbondesignsystem | ✅ Ready (Inspect) | Visit Preview | 💬 Add feedback | Sep 30, 2024 5:45pm |
tay1orjones
commented
4 days ago @alisonjoseph Yeah I was surprised too 😱
I'm not opposed to adding it to the nav, just felt 50/50 to me if we'd want it there. Sorta feels like it shouldn't be discoverable, to instead have users hit that page only when they're guided there? Like from the npm deprecation message or the package readme's. What do you think? I also couldn't figure out where we'd want to put it in the left nav 🤔
tay1orjones
commented
4 days ago @Kritvi-bhatia17 great points, thanks for bringing them up!
These deprecations are slightly different than feature-flag-related deprecations. These docs relate to the larger/more broad package and package version "deprecations" which happen after a package's end-of-support date. These are different from deprecations within the packages (components, functions, etc.). We should discuss and figure out where those "intra-package" deprecations docs should live. I skew towards continuing to document them in situ at the package-level storybook, but maybe there is a place for some kind of content about them on the website.
The package and version deprecations here will be immediately relevant on Monday as we'll be doing a formal deprecation on npm for both these packages, as well as v10.x versions of the other @carbon/colors, etc.
One other thing regarding the left nav concern is I think it's beneficial for this url to be as short as possible. We'll be using it in the deprecation message on npm and it will be printed in developer consoles where space is limited. Example:
This package is no longer supported. More info at carbondesignsystem.com/deprecationsvs
This package is no longer supported. More info at carbondesignsystem.com/components/overview/deprecations/
Kritvi-bhatia17
commented
4 days ago Oh, I see! Got it—thanks a lot, @tay1orjones, for such a detailed explanation.
If needed, we can discuss later how to handle feature-flag-related deprecations for both developers and designers. I believe there might already be a section for that on the website, but I’ll need to check; that’s a bit off-topic for now.
In any case, you guys have more knowledge and insight on this, will leave it up to y'll!
tay1orjones
commented
1 day ago @alisonjoseph @annawen1 @Kritvi-bhatia17 I've updated this to include the latest feedback, and also added a section for v10 elements packages and carbon-icons
aagonzales
commented
1 day ago I'm just going to leave this comment here since I didn't get it in before the merge. There are some formatting/visual things I would like to fix on this page if we ever make the deprecations page visible in the nav. Just to help with type hierarchy and information processing.
sstrubberg
commented
1 day ago I'm just going to leave this comment here since I didn't get it in before the merge. There are some formatting/visual things I would like to fix on this page if we ever make the deprecations page visible in the nav. Just to help with type hierarchy and information processing.
Derp! Sorry about that. I should have let you have a pass before merging.
tay1orjones
commented
1 day ago @aagonzales sounds good, the main thing I was optimizing for was anchor links per-package so we can deep link for support purposes. Like carbondesignsystem.com/deprecations#carbon-icons for example
Part of https://github.com/carbon-design-system/carbon/issues/12497
Changelog
New
carbondesignsystem.com/deprecationsfrom the deprecation message that will be visible on npmjs.com as well as developer terminal/consoles when installing the deprecated packages. but let me know what you think!