[x-license] Improve v9 license key version mismatch error guidance#22180
[x-license] Improve v9 license key version mismatch error guidance#22180aemartos wants to merge 8 commits intomui:masterfrom
Conversation
Bundle size
Deploy preview
Check out the code infra dashboard for more information about this PR. |
06d4da7 to
9f5c912
Compare
|
|
||
| # Migration from v8 to v9 | ||
|
|
||
| {{"component": "modules/components/V9LicenseUpgradeWarning.js"}} |
There was a problem hiding this comment.
I think we need to move this lower in the migration pages, for Pro and Premium users only.
Why: This currently gives the feeling to open source users that >50% of the users are paid, no, we are trying to make all the money from <10% of the users, so it's secondary, so it has to be lower.
There was a problem hiding this comment.
LGTM ... the comment from @oliviertassinari is a valid concern. Could you adjust this before merge please?
| @@ -1,5 +1,7 @@ | |||
| # Licensing | |||
|
|
|||
| {{"component": "modules/components/V9LicenseUpgradeWarning.js"}} | |||
There was a problem hiding this comment.
The description was designed to be right after the h1, to move after it, from a design perspective.
I was expecting docs-infra to break when this is not done, but surprisingly, it's resilient to it. So I think we need to update docs-infra to break in this case. cc @dav-is for awareness.
There was a problem hiding this comment.
To be fair, I think we never tried this, I don't remember this ever been an issue. Let's move it for now under the description.
| @@ -1,5 +1,7 @@ | |||
| # Licensing | |||
|
|
|||
| {{"component": "modules/components/V9LicenseUpgradeWarning.js"}} | |||
There was a problem hiding this comment.
To be fair, I think we never tried this, I don't remember this ever been an issue. Let's move it for now under the description.
| '', | ||
| 'The license key you are using is not compatible with the version of the MUI X packages installed.', | ||
| 'This happens when using a license key from a previous major version (e.g. a v8 license with v9 packages).', | ||
| 'The license key you are using was issued for an older major version of MUI X (e.g. a v8 license with v9 packages installed).', |
There was a problem hiding this comment.
| 'The license key you are using was issued for an older major version of MUI X (e.g. a v8 license with v9 packages installed).', | |
| // #npm-tag-reference | |
| 'The license key you are using was issued for an older major version of MUI X (e.g. a v8 license with v9 packages installed).', |
There was a problem hiding this comment.
This is needed so we don't forget to update the versions on the next major.
There was a problem hiding this comment.
Can we do the opposite, parametrize the console to be specific?
|
@oliviertassinari @mnajdova suggestions addressed.
@oliviertassinari there's no dedicated Pro/Premium section in these guides, so I placed it after
Agreed that the docs-infra side (crashing the build when something sits between the H1 and |
| from your <a href="https://mui.com/r/x-license-account/">MUI Store account</a>. The new | ||
| v9 key inherits the same expiration date as your existing v8 key, so there's no | ||
| extra cost during your current term. See{' '} | ||
| <a href="https://mui.com/r/x-license-key-upgrade/"> |
There was a problem hiding this comment.
Nitpick, but shouldn't the link be relative?
| <a href="https://mui.com/r/x-license-key-upgrade/"> | |
| <a href="/r/x-license-key-upgrade/"> |
There was a problem hiding this comment.
It was correct. This should be a global link so it continues to redirect to the right place as we introduce changes to our billing infrastructure. It shouldn't be tied to an old version redirect rule because we don't want to have to update old versions redirect rules.
29fac4b to
f1ae113
Compare
….com:aemartos/mui-x into aemartos/sto-127-enhance-v9-license-messages
Summary
Makes the v8 → v9 license key upgrade requirement more discoverable for existing customers, both in the console warning and across the docs. The trigger was #22173, where a customer upgraded to v9 and hit the watermark without realizing the key format had changed — the console message pointed them at the pricing page instead of the account page, and the docs mention was buried.
Changes
Console warning (
packages/x-license)License key version mismatchconsole warning to point existing customers to regenerate a key from their account (free, inherits expiration) instead of the pricing page.Redirects
Added two new
/r/x-*short links indocs/public/_redirects:/r/x-license-account→https://mui.com/store/account/licenses//r/x-license-key-upgrade→ How can I generate a v9 license key? (support article)Docs
docs/src/modules/components/V9LicenseUpgradeWarning.js, styled to match the native:::warningcallout.