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-11Lines changed: 11 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,26 +17,26 @@ 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:
And follow the prompts to initiate sync. Choose the **repo** to sync code from, the **branch or commit hash** version of the code to index, and new **collection name** for the synced code. (The collection will be created by the syncing process, and must not exist yet.)
On the Sync page, select "Create" to begin syncing code. If you have not already connected GitHub, you may be prompted to install the Chroma Cloud GitHub app again.
@@ -65,21 +65,21 @@ 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
-
{% MarkdocImage lightSrc="/sync/custom-github-app-screen.png" darkSrc="sync/custom-github-app-screen.png" alt="Creating a custom github app" /%}
82
+
{% MarkdocImage lightSrc="/sync/custom-github-app-screen.png" darkSrc="/sync/custom-github-app-screen.png" alt="Creating a custom github app" /%}
83
83
84
84
3.**Creating a source**
85
85
@@ -103,7 +103,7 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
103
103
104
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”:
105
105
106
-
{% MarkdocImage lightSrc="/sync/custom_source_invocation.png" darkSrc="sync/custom_source_invocation.png" alt="Creating a custom sync invocation" /%}
106
+
{% MarkdocImage lightSrc="/sync/custom_source_invocation.png" darkSrc="/sync/custom_source_invocation.png" alt="Creating a custom sync invocation" /%}
107
107
108
108
Alternatively, you can invoke the Sync Function by sending an API request to the Sync Function’s API:
0 commit comments