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

chore(docs): monorepos support #36504

Merged
merged 10 commits into from
Sep 7, 2022
34 changes: 34 additions & 0 deletions docs/docs/reference/cloud/monorepos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: "Monorepos"
description: "Monorepos support in Gatsby Cloud"
---

## Introduction

Gatsby Cloud has support for monorepos projects, but since there is a plethora of dependency management tools out there some issues can occure.
This document will walk you through the tools that are supported and how to troubleshoot some edge cases
Khaledgarbaya marked this conversation as resolved.
Show resolved Hide resolved

## Monorepo Support
Khaledgarbaya marked this conversation as resolved.
Show resolved Hide resolved

The following tables shows the level of support for each tool
Khaledgarbaya marked this conversation as resolved.
Show resolved Hide resolved

**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) | ◐ | |
LekoArts marked this conversation as resolved.
Show resolved Hide resolved
| Lerna | ● | |
| NPM Workspaces (v7 and onwards) | ● | |
| NX | ○ | Work is in progress |
Khaledgarbaya marked this conversation as resolved.
Show resolved Hide resolved
| Turborepo | ○ | We do not have plans to support Turborepo at this time. |

## Troubleshooting
Khaledgarbaya marked this conversation as resolved.
Show resolved Hide resolved