docs: Github Integration update (#27)

* docs: Github Integration update * docs: updated wording
invertase · Dec 21, 2023 · ec86b6d · ec86b6d
1 parent 479b11e
commit ec86b6d
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/docs/assets/connect-existing-github.png b/docs/assets/connect-existing-github.png
diff --git a/docs/assets/disconnect-existing-github.png b/docs/assets/disconnect-existing-github.png
diff --git a/docs/deployments/github-integration.mdx b/docs/deployments/github-integration.mdx
@@ -50,3 +50,19 @@ Framework Preset will be selected based on detected framework. Check the [Framew
 After configuration you can click on the `Deploy` button to create a new Project and trigger the first deployment.
 
 From now on, every time you push to GitHub, Globe will create a new deployment. If there is a new commit in the specified production branch (selected in the import stage), a production deployment will be created. For all other branches, a preview deployment is triggered.
+
+## Connecting to an Existing Project
+
+If a project already exists in Globe (for example, deployed via CLI), you can connect it to a GitHub Repository. Browse to the project you want to connect and click on **Settings** -> **Git**.
+
+![Existing Repository connect to Github](/assets/connect-existing-github.png)
+
+In this screen, you can click on the `Connect` button to connect the project to a GitHub repository.
+
+## Disconnecting a Github Repository
+
+If a project is already connected to a Repository in Globe, you can disconnect it by browsing to the project you want to disconnect and click on **Settings** -> **Git**.
+
+![Existing Repository disconnect to Github](/assets/disconnect-existing-github.png)
+
+In this screen, you can click on the `Disconnect` button to disconnect the project from a GitHub repository.