Sylwia/adds monorepo support section #54
Conversation
|
|
✅ Deploy Preview for stackblitz-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
I find that the information is a bit hidden, being a sub-section of a page in the Codeflow docs. The link from the FAQ helps a bit, but I wonder if we want it to be more visible and make the monorepo support information a top-level page. Monorepo support is a frequent question from Enterprise / big companies that are investigating StackBlitz (EE or SaaS). IMO a natural place would be to have a “Monorepo support” page in the WebContainers section. But if we want to prioritize people reading through the Codeflow docs, and want to pre-empt their questions as they read, the current placement might make sense. |
That was another option I was considering - thank you! I'll transclude it in both places:
wdyt, @fvsch ? |
|
@sylwiavargas FYI, I'm working on the solution where this is not needed anymore. It actually doesn't seem to be super difficult to get working but I don't want to count my chickens just yet. |
|
Hi @fvsch! I've transcluded the monorepo support page for WebContainers. Could you have a look please? |
|
|
||
| ## Running monorepos in Codeflow IDE | ||
|
|
||
| Codeflow IDE supports workspaces. Follow a walkthrough below to get your monorepo running in Codeflow. <!-- @include: ../parts/monorepo-support.md --> |
There was a problem hiding this comment.
Not fond of having a large content fragment that we include in several places, to be honest. I like having a single URL where content leaves. Might be better for SEO (avoids the risk of a search engine classing a page as duplicate content and removing it from its index), and for search (you don't get two competing results for the same information).
|
|
||
| Check [npm documentation](https://docs.npmjs.com/cli/v7/using-npm/workspaces) for more information or [this npm-based monorepo demo](https://stackblitz.com/edit/node-4cygsf?file=README.md) for reference. | ||
|
|
||
| ### pnpm |
There was a problem hiding this comment.
Having those entries as H3s works when including them in the working-in-codeflow-ide.md page, but not when including them in the dedicated monorepo-support.md page. In that second page, I would expect to see an outline but with H3s we're not getting one:
| ``` | ||
| "workspaces": [ | ||
| "packages/*" | ||
| ], |
There was a problem hiding this comment.
In this page, some of our examples of fragments from package.json use a final comma, and some don't. Can we harmonize it?
My vote would be for no trailing comma, because:
- it looks a bit distracting;
- if you copy this config to add it at the end of your
package.json, you have to add a comma before and remove the final comma.
It's hard to predict where users will need to add commas exactly to have valid JSON, so I'd rather let users be responsible for that. But I’m fine with always including the trailing comma if we think that's better (as long as we're consistent).
| Check [pnpm documentation](https://pnpm.io/workspaces) for more information or [this pnpm-based monorepo demo](https://stackblitz.com/edit/node-gw1rvh?file=README.md) for reference. | ||
|
|
||
|
|
||
| ### Yarn |
There was a problem hiding this comment.
Should we specify that we support Yarn v1 only?
I'm not sure if Yarn Berry (v2+) workspaces are exactly the same or different.
Co-authored-by: Florens Verschelde <florens@fvsch.com>
Co-authored-by: Florens Verschelde <florens@fvsch.com>
|
|
||
| The `workspace:` protocol ensures the correct package from the workspace is used. However, this is not required because, by default, pnpm will link packages from the workspace if the available packages match the declared ranges. | ||
|
|
||
| Check [pnpm documentation](https://pnpm.io/workspaces) for more information or [this pnpm-based monorepo demo](https://stackblitz.com/edit/node-gw1rvh?file=README.md) for reference. |
There was a problem hiding this comment.
Ideally the two example projects we link from this page could have:
- a more distinctive slug (for instance
sb-monorepo-example-pnpmandsb-monorepo-example-npm) - nice titles and descriptions
PR Description
Summary of my changes and explanation of my decisions
I've placed the monorepo section here but I'm wondering if many users of the classic editor would benefit from this information? Lemme know!
Self-check
Please check all that apply:
Contributors list
Would you like your contribution to be celebrated? Please check all that apply: N/a
I would like to be featured on the future contributors list in the README. If so, please tell us:
I would like to get a shoutout in the next monthly updates post. If so, please provide your twitter handle (or we will link to your GitHub profile).
⚡️ ⚡️ ⚡️ Thank you for contributing to StackBlitz ⚡️ ⚡️ ⚡️