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] Bootstrap docs/landing page site #542

Merged
merged 63 commits into from
Jul 15, 2022
Merged

[docs] Bootstrap docs/landing page site #542

merged 63 commits into from
Jul 15, 2022

Conversation

bharatkashyap
Copy link
Member

@bharatkashyap bharatkashyap commented Jun 9, 2022

@bharatkashyap bharatkashyap marked this pull request as draft June 9, 2022 14:07
@render
Copy link

render bot commented Jun 9, 2022

@oliviertassinari oliviertassinari temporarily deployed to landing-page - toolpad-db PR #542 June 9, 2022 14:07 — with Render Destroyed
@render
Copy link

render bot commented Jun 13, 2022

@oliviertassinari oliviertassinari temporarily deployed to landing-page - toolpad-db PR #542 June 13, 2022 19:42 — with Render Destroyed
@Janpot
Copy link
Member

Janpot commented Jun 14, 2022

@bharatkashyap Ok, this took some time to sort out. It's not finished, but at least there's something on the screen now.

The @mui/monorepo is a github dependency. yarn installs its dependencies so we can use things from e.g. the ./scripts folder. For the docs we are importing code from some of its workspaces. These are not installed in node_modules since yarn doesn't install workspaces of dependencies. Therefore anything trying to resolve them using the node module resolution algorithm (webpack) will fail to find them. Also their transitive dependencies are not installed. The workaround used in MUI X is to alias the package identifiers to their workspace inside the @ui/monorepo and by making sure that these packages are compiled.
I've removed the aliasing from babel config and added it to webpack. This really is a task for webpack, not for babel.
For this to work we must always make sure that:

  • Any transitive dependencies for the monorepo are installed in the docs workspace (e.g. react or @emotion/styled)
  • We specifiy the paths to the workspace packages correctly in next.config.json.

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 15, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jun 17, 2022
@Janpot
Copy link
Member

Janpot commented Jun 17, 2022

@bharatkashyap Before we invest more time in the docs content, we need to sort out the FOUC. if it can't be solved, then I don't want to continue with this brittle setup.

@bharatkashyap bharatkashyap marked this pull request as ready for review June 17, 2022 13:59
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 8, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 8, 2022
@bharatkashyap
Copy link
Member Author

Looks like @mui/toolpad-app is missing a dependency on @mui/utils?

Yes, this was the case. Fixed after adding this dependency to toolpad-app/package.json

@render
Copy link

render bot commented Jul 11, 2022

@oliviertassinari oliviertassinari requested a deployment to landing-page - toolpad-db PR #542 July 11, 2022 14:41 — with Render Abandoned
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 12, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 12, 2022
Copy link
Member

@Janpot Janpot left a comment

Choose a reason for hiding this comment

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

Awesome!

@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 14, 2022
@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 15, 2022
@bharatkashyap bharatkashyap merged commit f280d33 into master Jul 15, 2022
@bharatkashyap bharatkashyap deleted the landing-page branch July 15, 2022 07:46
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.

Build docs application [website] Landing page
5 participants