[core] Use main repo as source of truth

[oliviertassinari]

• https://deploy-preview-144--material-ui-x.netlify.app/components/autocomplete/#ComboBox.tsx
• https://deploy-preview-144--material-ui-x.netlify.app/storybook/

[oliviertassinari]

The beauty of the approach

[dtassone]

How aboutexport {default as MyApp} from...? 1 line

[oliviertassinari]

As far as I know, named export doesn't work with Next.js custom App: https://nextjs.org/docs/advanced-features/custom-app.

We could probably do

export { default } from '@material-ui/monorepo/docs/pages/_app';

But the commit the comment is based on is outdated, the file has grown to:

import MyApp from '@material-ui/monorepo/docs/pages/_app';
import { LicenseInfo } from '@material-ui/x-grid';

// Remove the license warning from demonstration purposes
LicenseInfo.setLicenseKey(
  '0f94d8b65161817ca5d7f7af8ac2f042T1JERVI6TVVJLVN0b3J5Ym9vayxFWFBJUlk9MTY1NDg1ODc1MzU1MCxLRVlWRVJTSU9OPTE=',
);

export default MyApp;

[oliviertassinari]

@dtassone It seems that we could move forward with the approach. There is still a lot to clean up (+123k LOC diff is wrong, should probably be 1/10 that figure), but a possible architecture is in place:

1. Install mui-org/material-ui as a dependency under @material-ui/monorepo
2. Use the sources from the mono repo for all the modules we want to share (prettier scripts, eslint config, documentation components, test scripts etc)
3. Have a new and second documentation website, hosted on material-ui-x.netlify.
4. Have the pages we are interested into proxied. We would have material-ui.com/components/data-grid proxy to material-ui-x.netlify.app/components/data-grid.

Et voilà, we can focus on building features, not infrastructure :D.

Advantages

• High consistency, we enforce with code that the two repositories stay aligned.
• Low effort, high impact, it should quickly work.

Drawbacks

• We will need to be careful with the versions of the dependencies, probably have to replicate what the docs folder has in the mono-repository anytime we update.
• Adding new pages will require to send a pull request on mui-org/material-ui as the source of truth for the overall navigation (sidenav + proxy). Hopefully, this is not everyday we add new documentation pages to cover new features.
• Can be seen as "dirty" as we transpile the node_modules/@material-ui/mono folder.

Overall, I think for us, it worth it. Thoughts?

[eps1lon]

Have you considered using git submodules instead?

[oliviertassinari]

Have you considered using git submodules instead?

@eps1lon I haven't seen git submodules in use since my first internship in the industry in 2014 but that doesn't mean they can't be a better solution to documenting the components. I'm looking into it.

[eps1lon]

I used them for https://github.com/eps1lon/material-ui-playroom to use the docs demos. Maybe something similar works too. Probably easier to handle than the indirection with another repo that needs to be published.

[dtassone]

I think this is a great temporary solution.

I tend to think that we should rethink the solution as a whole, Core, docs, and X.

I wouldn't spend more time on this, for now, as the solution will get to where we want.

[oliviertassinari]

For the little exploration I did with git submodules, it seems to shine especially in the case where work is required in material-ui in order to accommodate for constraints of material-ui-x. Is this a case we should optimize for? Not sure it will be very frequent. Outside of that, I didn't find anything (yet?) that is significantly better.

Also, it seems that we can switch between yarn git and git submodules without a massive refactorization, so maybe we could keep the same direction and course correct if we hit something compelling enough to switch later on?

[dtassone]

Nice one 👍

[oliviertassinari]

I'm not sure if the best part of the pull request is the −2,180 deleted lines (e.g. with eslintrc) or the fact that we have most of the infrastructure to put the documentation in production.

[dtassone]

Infra for doc 👍
eslintrc cleanup is the extra bit :)

[oliviertassinari]

@dtassone Should I migrate the first page, as an example so we can then parallelize the work?

[dtassone]

Sounds like a plan 😄