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 parent relationship to deprecations to allow grouping in the UI, especially in the index #1383

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kategengler
Copy link
Contributor

@kategengler kategengler commented Jun 4, 2024

  • Added since to the metadata display since I felt it was missing especially on the id route
  • Made id in the metadata display link to the individual id page to expose those URLs
  • Added some info to the README about the new relationship but also about adding deprecation guides

No deprecations currently use this, though I did certainly test it out. I am aiming to use this for #1381 so we do not lose the usefulness of the index. Due to the way the Deprecate import Ember from 'ember'`` deprecation is done, we need a URL for every single API even if they weren't ones that were at all used by the public. I don't want the index to scare people off of upgrading to 6.0, but there should still be a way to see all the related deprecations.

cc @NullVoxPopuli

especially in the index

- Added `since` to the metadata display since I felt it was missing
  especially on the id route
- Made id in the metadata display link to the individual id page to
  expose those URLs
- Added some info to the README about the new relationship but also
  about adding deprecation guides
Copy link

netlify bot commented Jun 4, 2024

Deploy Preview for ember-deprecations ready!

Name Link
🔨 Latest commit 35847f9
🔍 Latest deploy log https://app.netlify.com/sites/ember-deprecations/deploys/665f7367f4770500083a6c30
😎 Deploy Preview https://deploy-preview-1383--ember-deprecations.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Contributor

@NullVoxPopuli NullVoxPopuli left a comment

Choose a reason for hiding this comment

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

behavior seems good 🎉

@MinThaMie
Copy link
Contributor

We discussed this during our learning meeting on 17th of June, and while we understand that it's a ton of deprecations we believe introducing this new data pattern/structure is not necessary and makes it more complicated to maintain.

We have plans to structurally address the issue you ran into. I hope you understand :) Thanks for the PoC!

@kategengler
Copy link
Contributor Author

Do you have a timeline for addressing the issue? We're attempting to land the deprecation of import Ember from 'ember' which is the one that introduces 150 deprecations, most of which will not be relevant for most users.

@MinThaMie
Copy link
Contributor

We're happy to land that deprecation as is :) it does not seem to effect the usability of the page, so you could merge import Ember from ember right now if you want to.

@kategengler
Copy link
Contributor Author

To me it greatly affects the usability of that page. I find users often browse deprecations by version to get an idea of what is required for a particular upgrade. Adding 150 deprecations, most of which are for things that are somewhat esoteric, is very discouraging for someone looking at that list -- it isn't easy to tell at a glance that they are grouped under this deprecation of the import of Ember. It also drowns out the other deprecations with that version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants