Update docs to clarify multi repo support (#2552)

* Update docs to clarify multi repo support * Update configuration.md * Update docs/guides/multi_repo.md Co-authored-by: Trey Spiller <treyspiller@gmail.com> * Update docs/guides/multi_repo.md Co-authored-by: Trey Spiller <treyspiller@gmail.com> * Update docs/guides/multi_repo.md Co-authored-by: Trey Spiller <treyspiller@gmail.com> --------- Co-authored-by: Toby Mao <toby.mao@gmail.com> Co-authored-by: Trey Spiller <treyspiller@gmail.com>
TobikoData · May 2, 2024 · f0ae0a1 · f0ae0a1
1 parent e6294d9
commit f0ae0a1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/guides/multi_repo.md b/docs/guides/multi_repo.md
@@ -163,3 +163,17 @@ The target environment has been updated successfully
 ```
 
 SQLMesh correctly detects a breaking change and allows you to perform a multi-repo backfill.
+
+## Configuring projects with multiple repositories
+
+To add support for multiple repositories, add a `project` key to the config file in each of the respective repos. 
+
+```yaml
+project: repo_1
+
+gateways:
+...
+```
+
+Even if you do not have a need for multiple repos now, consider adding a `project` key so that you can easily support multiple repos in the future.
+
diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md
@@ -19,6 +19,7 @@ Configuration options for SQLMesh project directories.
 | Option            | Description                                                                                                        |     Type     | Required |
 | ----------------- | ------------------------------------------------------------------------------------------------------------------ | :----------: | :------: |
 | `ignore_patterns` | Files that match glob patterns specified in this list are ignored when scanning the project folder (Default: `[]`) | list[string] |    N     |
+| `project`         | The project name of this config. Used for [multi-repo setups](../guides/multi_repo.md).                            | string       |    N     |
 
 ### Environments