Skip to content

Commit

Permalink
chore(docs): monorepos support (#36504)
Browse files Browse the repository at this point in the history
Co-authored-by: Lennart <lekoarts@gmail.com>
  • Loading branch information
Khaledgarbaya and LekoArts committed Sep 7, 2022
1 parent 8aeae21 commit b55e1d5
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/docs/reference/cloud/monorepos.md
@@ -0,0 +1,43 @@
---
title: "Monorepos"
description: "Monorepos support in Gatsby Cloud"
---

## Introduction

Gatsby Cloud has support for projects organized as [monorepos](https://monorepo.tools/), but since there are different competing tools to build a monorepo it's important to know what Gatsby Cloud supports today.

This document will explain which tools are supported and how you can troubleshoot issues.

## Supported tools

The following table shows the level of support for each tool.

**Legend:**

| Icon | Feature Capability |
| ---- | ---------------------------------------- |
|| Fully Supported |
|| Somewhat Supported (support is minimal ) |
|| Not Supported |

**Support:**

| Tool. | Level of Support | Notes |
| -------------------------------- | ---------------- | ------------------------------------------------------- |
| Yarn Workspaces (v1) || |
| Yarn Workspaces (v2/v3 with PnP) || |
| Lerna || |
| NPM Workspaces (v7 and onwards) || |
| NX || Work in progress |
| Turborepo || We do not have plans to support Turborepo at this time. |

## Troubleshooting

### PnP and Yarn compatibility issues

Some tools don't work under Plug'n'Play environments, check the Yarn [compatibility table](https://yarnpkg.com/features/pnp#compatibility-table). You can enable the built-in `node-modules` plugin by adding the following into your local `.yarnrc.yml` file before running a fresh `yarn install`:

```yml
nodeLinker: node-modules
```

0 comments on commit b55e1d5

Please sign in to comment.