Skip to content

[docs] Add "upgrade to v8" callout on v7 planned pages #17901

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

Merged
merged 1 commit into from
May 21, 2025

Conversation

mapache-salvaje
Copy link
Contributor

@mapache-salvaje mapache-salvaje commented May 19, 2025

Updates the copy on "planned" pages in the v7 docs to instruct users to upgrade to v8 to use the features.

Preview: https://deploy-preview-17901--material-ui-x.netlify.app/x/react-data-grid/pivoting/

@mapache-salvaje mapache-salvaje added docs Improvements or additions to the documentation v7.x labels May 19, 2025
@mapache-salvaje mapache-salvaje marked this pull request as ready for review May 19, 2025 15:03
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Nice improvement. 👍
WDYT, would it make sense to change the menu items to be shown as new instead of planned at the same time? 🤔


Don't hesitate to leave a comment on the same issue to influence what gets built. Especially if you already have a use case for this component, or if you are facing a pain point with your current solution.
:::success
Pivoting is available in MUI X v8+.
Copy link
Member

Choose a reason for hiding this comment

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

WDYT about linking to the feature on v8 as well? 🤔

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good question. As a general rule I'm hesitant to add more than one link—ideally there should be only one action for the user to take after reading, or else we risk sending people in too many different directions. With that in mind, I would much prefer to direct them to upgrade instead of reading a doc for a feature they can't use (yet). All that said, if others would like see the features linked then I'm ok with it.

Copy link
Member

Choose a reason for hiding this comment

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

No strong preference here.
If you think that it hinders UX, I'm fine and agree that the main actionable item is the upgrade guide. 👌

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Cool, I'll leave it as is then, and we can always come back and add the links later if it seems like users need them.

@oliviertassinari oliviertassinari added type: enhancement This is not a bug, nor a new feature scope: data grid Changes or issues related to the data grid product labels May 19, 2025
@oliviertassinari oliviertassinari changed the title [docs] Add "upgrade to v8" callout on v7 planned pages [data grid][docs] Add "upgrade to v8" callout on v7 planned pages May 19, 2025
@mapache-salvaje mapache-salvaje removed the scope: data grid Changes or issues related to the data grid product label May 20, 2025
@mapache-salvaje mapache-salvaje changed the title [data grid][docs] Add "upgrade to v8" callout on v7 planned pages [docs] Add "upgrade to v8" callout on v7 planned pages May 20, 2025
@mapache-salvaje
Copy link
Contributor Author

mapache-salvaje commented May 20, 2025

WDYT, would it make sense to change the menu items to be shown as new instead of planned at the same time?

I debated updating these messages but ultimately decided not to. Where do we draw the line with maintenance of past docs versions? After updating from "planned" to "new" now, would we come back to the v7 docs after v9 to remove all of the "new" chips altogether? In the interest of keeping maintenance needs to a minimum, I'd err on the side of leaving most things in the v7 docs untouched from here on out, except where it's trivially simple to cherry-pick v8 changes.

@mapache-salvaje
Copy link
Contributor Author

(I reverted the title back to remove [data grid] since this PR also includes the Date Pickers)

@LukasTy
Copy link
Member

LukasTy commented May 21, 2025

Fair points. 👌
It was just a curious suggestion, but I agree that the introduction of strange behavior might not be worth it. 👍

@mapache-salvaje mapache-salvaje merged commit 2bcc626 into mui:v7.x May 21, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation type: enhancement This is not a bug, nor a new feature v7.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants