Skip to content

Commit 96970bf

Browse files
committed
add screenshots for platform use case
1 parent c488fd3 commit 96970bf

File tree

6 files changed

+11
-17
lines changed

6 files changed

+11
-17
lines changed

docs/docs.trychroma.com/markdoc/content/cloud/sync/github-sync.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
1717

1818
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:
1919

20-
{% MarkdocImage lightSrc="/sync/sync_create_database.png" darkSrc="sync/sync_create_database.png" alt="Create database screen" /%}
20+
{% MarkdocImage lightSrc="/sync/sync_create_database.png" darkSrc="sync/sync_create_database.png" alt="Create database screen" /%}
2121

2222
On the setup screen, select "Sync a GitHub repo":
2323

@@ -65,31 +65,25 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
6565

6666
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:
6767

68-
[INSERT SCREENSHOT]
68+
{% MarkdocImage lightSrc="/sync/sync_create_database.png" darkSrc="sync/sync_create_database.png" alt="Create database screen" /%}
6969

7070
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:
7171

72-
[INSERT SCREENSHOT]
72+
{% MarkdocImage lightSrc="/sync/api_keys.png" darkSrc="sync/api_keys.png" alt="API key issuance for Chroma Cloud" /%}
7373

7474
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:
7575

76-
[INSERT SCREENSHOT]
76+
{% MarkdocImage lightSrc="/sync/github_app_id.png" darkSrc="sync/github_app_id.png" alt="GitHub App ID" /%}
7777

78-
With these credentials, you can use the Chroma dashboard to register your GitHub App with Chroma:
78+
{% MarkdocImage lightSrc="/sync/github_secret_key.png" darkSrc="sync/github_secret_key.png" alt="GitHub Secret Key" /%}
7979

80-
[INSERT SCREENSHOT]
80+
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.**
8181

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" /%}
8783

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**
9185

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:
9387

9488
```bash
9589
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
107101

108102
4. **Invoking the Sync Function**
109103

110-
To invoke the Sync Function, you must select a source on which to create the invocation. See the previous step for details on how to create a source. Once you select the source, you can invoke the Sync Function by clicking “[INSERT COPY]”:
104+
To invoke the Sync Function, you must select a source on which to create the invocation. See the previous step for details on how to create a source. Once you select the source in the UI, you can invoke the Sync Function by clicking “Create invocation”:
111105

112-
[INSERT SCREENSHOT]
106+
{% MarkdocImage lightSrc="/sync/custom_source_invocation.png" darkSrc="sync/custom_source_invocation.png" alt="Creating a custom sync invocation" /%}
113107

114108
Alternatively, you can invoke the Sync Function by sending an API request to the Sync Function’s API:
115109

139 KB
Loading
225 KB
Loading
219 KB
Loading
213 KB
Loading
79.7 KB
Loading

0 commit comments

Comments
 (0)