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

[Docs Rewrite] Remove "Using Immutable.js" page #4052

Closed
markerikson opened this issue Apr 1, 2021 · 3 comments
Closed

[Docs Rewrite] Remove "Using Immutable.js" page #4052

markerikson opened this issue Apr 1, 2021 · 3 comments
Labels

Comments

@markerikson
Copy link
Contributor

markerikson commented Apr 1, 2021

The Using Immutable.js with Redux page was originally submitted by a user who was enthusiastic about that library. Since they put the time into writing it, and it was relevant, we merged it.

Since then, the situation has changed considerably. We now specifically recommend that you should use Immer and you should not use Immutable.js.

So, it's time to remove that Immutable.js docs page entirely.

The only real question is what redirect we should add to ensure that incoming links pointing to that page end up at a real location. Maybe point to the "Use Immer" Style Guide link? Note that this should be done by specifically adding a line to website/_redirects that lists the old URL (and probably has a * splat in it), and points to the new URL.

We may also need to make updates to the "Immutable Data" FAQ page as well to remove any existing references to Immutable.js (and may want to add a new entry on that page that says "Should I Use Immutable.js? No, because...").

@AaronPowell96
Copy link
Contributor

AaronPowell96 commented Apr 1, 2021

Could the redirect go to https://redux.js.org/style-guide/style-guide#use-immer-for-writing-immutable-updates ?
It clearly states "Use Immer for Writing Immutable Updates", so if somebody were directed to immutable.js via an old article etc, they can clearly read that it is now recommended to use Immer? :)

Edit: I think you stated that above actually!
Could I have an attempt at this, having never commited to this repo or having used Immer / ImmutableJS before? It's okay if not! (If you need a new section write up on the differences etc)

@markerikson
Copy link
Contributor Author

Sure, go ahead! In theory, the necessary changes are:

  • Remove the existing Markdown file for this page
  • Search the codebase and remove any other links to that Markdown file
  • Remove the entry for the page from website/sidebars.js
  • Add the _redirects entry

@markerikson
Copy link
Contributor Author

And fixed by #4053 .

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

No branches or pull requests

2 participants