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] DataGrid is in the lab #612

Merged
merged 1 commit into from
Nov 23, 2020

Conversation

oliviertassinari
Copy link
Member

@oliviertassinari oliviertassinari commented Nov 21, 2020

#568 (comment), same treatment that for the date picker.

Capture d’écran 2020-11-21 à 17 08 14

Twin with mui/material-ui#23643

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Nov 21, 2020
pathname: '/components',
subheader: '/components/data-grid',
children:
process.env.CONTEXT === 'production'
Copy link
Member

Choose a reason for hiding this comment

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

What's the purpose? It seems like the objects are identical...

Copy link
Member Author

@oliviertassinari oliviertassinari Nov 21, 2020

Choose a reason for hiding this comment

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

Identical until they are not :). We used to have different pages. I think that it's interesting to work on new features without releasing them to customers. But maybe it's no longer something that we need 🤔. I guess it's in the lab anyway. Actually, no, it's probably useful when features are highly unstable. It's not like in the core, some features take weeks to be built. Even for a lab state, that might not be good enough.

@dtassone
Copy link
Member

I think the grid will have less visibility in the lab, and I think it's less visible that it's an enterprise component part of a bigger package.
How about we do an Material-UI X menu item in the doc?

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Nov 23, 2020

  1. I don't think that the data grid would get less visibility if it's in the lab. I think that most developers search with Google, or Algolia, barely use the side menu. At least, I almost never do when browsing the documentation of AWS, Docker, TypeScript, etc. I came in with one specific problem to solve. Most of the adoption comes from the Table page, so if the impact there is, marginal.
  2. I think that displaying it in the lab is important for transparency. The component would likely only reach a stable state with v5. I think it's what will get the biggest impact on developers: are they willing to go with an alpha version? At least, they know it beforehand, which is a better long term.
  3. The question around: Should we get a dedicated documentation section for Material-UI X, as we have for the System or should we blend it together with the other components, is definitely strategic, marking, and important.
    This reminds me [RFC] Should we host MUI X on the main repository? #25. @mbrookes thoughts? I would be leaning toward communicating this message: a single coherent set of components. It seems to be another variation of the problem we had to answer when we worked on the icon for Material-UI X: subbrand, sister brand, or premium version? We went for a premium version with the optionality to have it a sister brand of Material-UI community. What would gain with a separation?

@mbrookes
Copy link
Member

@mbrookes thoughts?

I'm on the fence. I think I'd need to see it both ways and see what feels right. I can see pros and cons for both.

@mbrookes
Copy link
Member

No, answering the question asked:

Should we get a dedicated documentation section for Material-UI X, as we have for the System or should we blend it together with the other components(?)

@oliviertassinari
Copy link
Member Author

I'm moving forward, I think that what's important is the semver part.

There might be one point of confusion with having the data grid in the lab, it's not hosted in @material-ui/lab. However, IMHO, better be upfront with developers. The packages are released as alpha. The main incentive for the existence of the lab is semver: https://next.material-ui.com/components/about-the-lab/. We can reevaluate in a couple of days/week if this had a negative impact on adoption or sales.

@oliviertassinari oliviertassinari merged commit 316109b into mui:master Nov 23, 2020
@oliviertassinari oliviertassinari deleted the data-grid-lab branch November 23, 2020 20:04
@mbrookes
Copy link
Member

I'm moving forward

I thought the discussion was with respect to where it ends up when it leaves lab?

@oliviertassinari
Copy link
Member Author

oliviertassinari commented Nov 23, 2020

Where it ends up when it leaves lab?

@mbrookes Oh yeah sure, I was assuming that if we would be going in this direction, we could have a lab for Material-UI X too and move it there directly.

Pros for going back to where it was:

  • different sections in the documentation would be frustrating for developers, having to switch between them.

Pros for having a different section for Material-UI X: 

  • make it easier for developers to see what's free and what's paid? But even then, I'm not sure if that would be very relevant. The approach with the date range picker seems to work well:

Capture d’écran 2020-11-23 à 21 27 28

At the end of the day, I think that the main difference is about the message we communicate to developers. I think that sending the signal that all the components are designed to play well together allows us to differentiate again stitching together a bunch of open-source components.

What would be the signal if we isolate Material-UI and Material-UI X? Is Data Grid Material-UI or Material-UI X? Is Date Picker Material-UI or Material-UI X?

oliviertassinari added a commit to oliviertassinari/mui-x that referenced this pull request Nov 27, 2020
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants