Skip to content

Commit 54c2de9

Browse files
[DOC] update platform sync installation docs (#5837)
Adds information about self-installation. --------- Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
1 parent 8d05470 commit 54c2de9

File tree

5 files changed

+21
-9
lines changed

5 files changed

+21
-9
lines changed

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

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ name: GitHub
77

88
## Direct Sync
99

10-
Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub app. To use your own custom GitHub app, use [Platform Sync](/cloud/sync/overview#platform-sync).
10+
Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub app. To use your own custom GitHub app, use [Platform Sync](/cloud/sync/github#platform-sync).
1111

1212
1. **Prerequisites**
1313

@@ -57,9 +57,21 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
5757

5858
## Platform Sync
5959

60+
{% Banner type="note" title="Team & Enterprise only" %}
61+
Platform Sync is only available on Chroma Cloud [Team and Enterprise plans](https://trychroma.com/pricing).
62+
{% /Banner %}
63+
64+
6065
1. **Prerequisites**
6166

62-
This walkthrough assumes that you have an existing GitHub App that has been installed into at least one non-empty GitHub account or organization.
67+
This walkthrough assumes that you have already [created a GitHub App](https://docs.github.com/en/apps/creating-github-apps/about-creating-github-apps/about-creating-github-apps) and installed it into at least one GitHub account or organization.
68+
69+
The GitHub App must have read-only access to the “Contents” and “Metadata” permissions listed under “Repository permissions.” These permissions ensure Chroma can index repositories authorized on the GitHub app.
70+
71+
{% MarkdocImage lightSrc="/sync/gh-contents.png" darkSrc="/sync/gh-contents.png" alt="GitHub App contents" /%}
72+
73+
{% MarkdocImage lightSrc="/sync/gh-metadata.png" darkSrc="/sync/gh-metadata.png" alt="GitHub App metadata" /%}
74+
6375

6476
2. **Setup**
6577

@@ -77,7 +89,11 @@ Direct Sync is the default syncing method, which uses the Chroma Cloud GitHub ap
7789

7890
{% MarkdocImage lightSrc="/sync/github_secret_key.png" darkSrc="/sync/github_secret_key.png" alt="GitHub Secret Key" /%}
7991

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.**
92+
With these credentials, navigate to the "Sync" -> "New GitHub sync" -> "Register your GitHub app" to configure your GitHub App with Chroma.
93+
94+
{% MarkdocImage lightSrc="/sync/platform_setup.png" darkSrc="/sync/platform_setup.png" alt="Platform setup" /%}
95+
96+
On the "Connect your custom GitHub app" screen, submit the App ID and private key from GitHub:
8197

8298
{% MarkdocImage lightSrc="/sync/custom-github-app-screen.png" darkSrc="/sync/custom-github-app-screen.png" alt="Creating a custom github app" /%}
8399

docs/docs.trychroma.com/markdoc/content/cloud/sync/overview.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,9 @@ The direct tier requires you to install Chroma’s GitHub App into any repositor
2727

2828
### Platform Sync
2929

30-
The platform tier requires you to grant Chroma access to a GitHub App that you own, which has been installed into the private repositories you wish to sync. This GitHub App must have read-only access to the “Contents” and “Metadata” permissions on the list of “Repository permissions”:
30+
The platform tier requires you to grant Chroma access to a GitHub App that you own, which has been installed into the private repositories you wish to sync. This GitHub App must have read-only access to the “Contents” and “Metadata” permissions on the list of “Repository permissions”.
3131

32-
{% MarkdocImage lightSrc="/sync/gh-contents.png" darkSrc="/sync/gh-contents.png" alt="GitHub App contents" /%}
33-
34-
{% MarkdocImage lightSrc="/sync/gh-metadata.png" darkSrc="/sync/gh-metadata.png" alt="GitHub App metadata" /%}
35-
36-
The platform tier grants access to the Chroma Sync API and is ideal for companies and organizations that offer services which access their users’ codebases. The platform tier is available on Chroma’s Team plan. If you are interested in using it, please reach out to us at [[email protected]](mailto:[email protected]).
32+
The platform tier grants access to the Chroma Sync API and is ideal for companies and organizations that offer services which access their users’ codebases. For a detailed walkthrough, see [Platform Sync docs](/cloud/sync/github#platform-sync).
3733

3834
## Web
3935

344 KB
Loading
-1.55 KB
Loading
307 KB
Loading

0 commit comments

Comments
 (0)