[docs] Refresh the license key documentation #3529

oliviertassinari · 2021-12-31T20:05:21Z

https://deploy-preview-3529--material-ui-x.netlify.app/components/data-grid/getting-started/#licenses

I'm opening this PR to address questions that we frequently hear on the sales@mui.com channel and to polish.

First and foremost, I distinguish the notion of license key and license the two are different. Developers shouldn't assume that the license key is everything. It's only a reminder.
I update the screenshots, to be more up-to-date. I used the opportunity to add a dark mode variant for them
People that ask about how to protect their license key: they don't need.

We would like to know your recommendations about how to secure the license key in our SPAs.

https://mui.zendesk.com/agent/tickets/1803

I bought MUI X Pro for myself, but if I push my code to GitLab every developer who works in my company can steal my license key and use it for free. What can I do to protect my key?

https://mui.zendesk.com/agent/tickets/1863

We stored this license key in an Environment variable within our project, but it might be accessible by unwanted 3rd parties since it's stored on the frontend side. Do you have restrictions to using this license? Maybe domain-specific?

https://mui.zendesk.com/agent/tickets/1878

how can I protect that in the future another developer can use my license when maintaining it?

https://mui.zendesk.com/agent/tickets/1900

People that ask about what happens with majors

I have a license key for the Material UI 4 XGrid. Can I use the same license key for Material UI 5 Data Grid Pro?

https://mui.zendesk.com/agent/tickets/1937

Cover https://stackoverflow.com/questions/70838326/where-should-the-mui-x-pro-license-key-be-installed/70901041

oliviertassinari · 2021-12-31T20:06:24Z

docs/src/pages/components/data-grid/getting-started/getting-started.md


-Once you purchase a license, you'll receive a license key.
-This key should be provided to the enterprise package to remove the watermark and
+You are [free to install](https://mui.com/store/legal/mui-x-eula/#evaluation-trial-licenses) and try `DataGridPro` as long as it is not used for development of a feature intended for production.


I anticipate for what we explored in https://github.com/mui-org/mui-store/pull/81 (we reverted this PR) but still it's going to be the same URL, as far as I know.

oliviertassinari · 2021-12-31T20:06:35Z

docs/src/pages/components/data-grid/getting-started/getting-started.md

@@ -200,10 +196,21 @@ The enterprise components come in two plans: Pro and Premium.
 | [Keyboard navigation](/components/data-grid/accessibility/#keyboard-navigation)           |    ✅     |                 ✅                 |                     ✅                     |
 | [Localization](/components/data-grid/localization/)                                       |    ✅     |                 ✅                 |                     ✅                     |

-### License key installation
+### Evaluation (trial) licenses


Same header as in the EULA

oliviertassinari · 2021-12-31T20:06:48Z

packages/grid/_modules_/grid/components/Watermark.tsx

    case LicenseStatus.NotFound:
-      return 'MUI X Unlicensed product';
+      return 'MUI X Missing license key';


This was confusing

oliviertassinari · 2021-12-31T20:06:55Z

packages/grid/_modules_/grid/components/Watermark.tsx

@@ -4,11 +4,11 @@ import { useLicenseVerifier, LicenseStatus } from '@mui/x-license-pro';
 function getLicenseErrorMessage(licenseStatus: LicenseStatus) {
  switch (licenseStatus) {
    case LicenseStatus.Expired:
-      return 'MUI X License Expired';
+      return 'MUI X License key expired';


License key + heading capitalization convention. So far, we only capitalize each word for the roles (e.g. Staff Software Engineer).

docs/src/pages/components/data-grid/getting-started/getting-started.md

docs/src/pages/components/data-grid/overview/overview.md

packages/grid/_modules_/grid/components/Watermark.tsx

updated

joserodolfofreitas

Leaving a few suggestions.

docs/src/pages/components/data-grid/getting-started/getting-started.md

Co-authored-by: Matt <github@nospam.33m.co>

Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>

mui-bot · 2022-01-28T22:42:08Z

These are the results for the performance tests:

Test case	Unit	Min	Max	Median	Mean	σ
Filter 100k rows	ms	1,101.5	1,726.5	1,167.4	1,340.9	261.762
Sort 100k rows	ms	694.3	1,260.1	694.3	949.02	210.626
Select 100k rows	ms	145.1	211.6	184.8	180	22.768
Deselect 100k rows	ms	86.9	164.1	86.9	113.74	27.783

Generated by 🚫 dangerJS against 32f68ae

…ui-x-pro-license-key-be-installed/70901041

oliviertassinari added the docs Improvements or additions to the documentation label Dec 31, 2021

oliviertassinari commented Dec 31, 2021

View reviewed changes

oliviertassinari force-pushed the docs-improve-license branch 3 times, most recently from 435b6e9 to 8fdbdaf Compare December 31, 2021 20:12

oliviertassinari requested a review from mbrookes December 31, 2021 23:11

mbrookes previously requested changes Jan 2, 2022

View reviewed changes

oliviertassinari force-pushed the docs-improve-license branch from 2079f27 to 0847cd2 Compare January 12, 2022 21:41

oliviertassinari force-pushed the docs-improve-license branch from 1cda212 to bb3ee09 Compare January 12, 2022 22:24

oliviertassinari requested review from mbrookes and joserodolfofreitas January 12, 2022 22:35

joserodolfofreitas reviewed Jan 19, 2022

View reviewed changes

oliviertassinari and others added 10 commits January 28, 2022 23:35

[docs] Refresh the license key documentation

4492858

Matt's review

2b687f8

Co-authored-by: Matt <github@nospam.33m.co>

More polish

aa265f4

Co-authored-by: Matt <github@nospam.33m.co>

More polish

a94495f

Co-authored-by: Matt <github@nospam.33m.co>

duplicate sentence

4ff7ecc

improve plan description

8839ad7

clearer

f2192cb

Matt's feedback

2c05698

Jose's feedback

d054bff

Co-authored-by: José Rodolfo Freitas <joserodolfo.freitas@gmail.com>

prettier

be4a659

oliviertassinari force-pushed the docs-improve-license branch from 6a4a0a9 to be4a659 Compare January 28, 2022 22:37

fix regression

b9165b2

cover https://stackoverflow.com/questions/70838326/where-should-the-m…

32f68ae

…ui-x-pro-license-key-be-installed/70901041

oliviertassinari merged commit 2d4c5a8 into mui:master Jan 28, 2022

oliviertassinari deleted the docs-improve-license branch January 28, 2022 23:05

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[docs] Refresh the license key documentation #3529

[docs] Refresh the license key documentation #3529

oliviertassinari commented Dec 31, 2021 •

edited

oliviertassinari Dec 31, 2021

oliviertassinari Dec 31, 2021

oliviertassinari Dec 31, 2021

oliviertassinari Dec 31, 2021 •

edited

joserodolfofreitas left a comment

mui-bot commented Jan 28, 2022 •

edited

[docs] Refresh the license key documentation #3529

[docs] Refresh the license key documentation #3529

Conversation

oliviertassinari commented Dec 31, 2021 • edited

oliviertassinari Dec 31, 2021

Choose a reason for hiding this comment

oliviertassinari Dec 31, 2021

Choose a reason for hiding this comment

oliviertassinari Dec 31, 2021

Choose a reason for hiding this comment

oliviertassinari Dec 31, 2021 • edited

Choose a reason for hiding this comment

joserodolfofreitas left a comment

Choose a reason for hiding this comment

mui-bot commented Jan 28, 2022 • edited

oliviertassinari commented Dec 31, 2021 •

edited

oliviertassinari Dec 31, 2021 •

edited

mui-bot commented Jan 28, 2022 •

edited