You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/docs.trychroma.com/markdoc/content/cloud/sync/github-sync.md
+11-17Lines changed: 11 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
17
17
18
18
If you do not already have a Chroma Cloud account, you will need to create one at [trychroma.com](https://www.trychroma.com). After creating an account, you can create a database by specifying a name:
@@ -65,31 +65,25 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
65
65
66
66
If you do not already have a Chroma Cloud account, you will need to create one at [trychroma.com](https://www.trychroma.com). After creating an account, you can create a database by specifying a name:
Once you have a database, you should create an API key to be able to access the Sync Function’s API. You can choose to make this API key scoped to all databases on your account or only the one you just created:
The final setup step is to grant Chroma access to the repositories to which your GitHub App has access. You will need to retrieve the app’s ID and private key from GitHub:
With these credentials, you can use the Chroma dashboard to register your GitHub App with Chroma. **Contact [[email protected]](mailto:[email protected]) for access to this feature.**
81
81
82
-
3.**Creating a source**
83
-
84
-
To create a source, you should select the GitHub App you registered with Chroma in the previous step:
85
-
86
-
[INSERT SCREENSHOT]
82
+
{% MarkdocImage lightSrc="/sync/custom-github-app-screen.png" darkSrc="sync/custom-github-app-screen.png" alt="Creating a custom github app" /%}
87
83
88
-
The dashboard will display the repositories available to this GitHub App, and from this list you can select the repository for which you would like to create a source:
89
-
90
-
[INSERT SCREENSHOT]
84
+
3.**Creating a source**
91
85
92
-
Alternatively, you can create a source by sending an API request to the Sync Function’s API:
86
+
To create a source, must send an API request to the Sync Function’s API:
93
87
94
88
```bash
95
89
curl -X POST https://sync.trychroma.com/api/v1/sources \
@@ -107,9 +101,9 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
107
101
108
102
4. **Invoking the Sync Function**
109
103
110
-
To invoke the Sync Function, you must selectasource on which to create the invocation. See the previous step for details on how to create a source. Once you selectthe source, you can invoke the Sync Function by clicking “[INSERT COPY]”:
104
+
To invoke the Sync Function, you must selectasource on which to create the invocation. See the previous step fordetails on how to create a source. Once you select the sourcein the UI, you can invoke the Sync Function by clicking “Create invocation”:
111
105
112
-
[INSERT SCREENSHOT]
106
+
{% MarkdocImage lightSrc="/sync/custom_source_invocation.png" darkSrc="sync/custom_source_invocation.png" alt="Creating a custom sync invocation" /%}
113
107
114
108
Alternatively, you can invoke the Sync Function by sending an API request to the Sync Function’s API:
0 commit comments