Skip to content

Commit 635f613

Browse files
authored
improvement(search): clarify integration approval and setup (#7673)
1 parent 345bfe2 commit 635f613

16 files changed

Lines changed: 359 additions & 250 deletions

apps/docs/content/docs/search/confluence.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Admin setup uses your organization's **Settings → Sources** page. Teammates co
2020
| **Central account** | One account syncs content, space permissions, page restrictions, and group membership. | Connect their own Confluence account so Sim can match their Atlassian identity to those permissions. |
2121
| **Member accounts** | Sim syncs content separately through connected members' accounts. | Connect their own Confluence account to establish which pages they can access. |
2222

23-
Adding a source from **Settings → Sources → Confluence → Sources** opens central account setup. Use this when one account can read the intended spaces and their permissions. For a member source, start **Connect account** from **Integrations** in the main sidebar after an admin adds Confluence. Available methods depend on your organization's enabled features.
23+
Selecting **Add source** on Confluence's integration page opens central account setup. Use this when one account can read the intended spaces and their permissions. For a member source, start **Connect account** from **Integrations** in the main sidebar after an admin allows Confluence. Available methods depend on your organization's enabled features.
2424

2525
**Everyone still connects in both methods.** With a central account, teammates supply their identity; they do not configure another central crawl or choose spaces again.
2626

@@ -40,7 +40,7 @@ On hosted Sim, personal connections authorize the existing Sim app. Teammates do
4040

4141
### Choose Confluence
4242

43-
Open **Settings → Sources → Add integration** and choose **Confluence**. On its **Sources** tab, select **Add source**. If Confluence is already listed, open it directly. **Setup guide** opens this guide from the source form.
43+
Open **Settings → Sources** and turn on **Confluence** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**. **Setup guide** opens this guide from the source form.
4444

4545
</Step>
4646
<Step>
@@ -79,9 +79,9 @@ Each teammate completes this last step. A previously authorized account may alre
7979

8080
## Connect member accounts
8181

82-
After an admin adds Confluence, open **Integrations** in the main sidebar and select **Connect account**. If there is no source yet, enter **Confluence Domain** and **Space Keys**, then select **Connect** and authorize your account. For another site or space scope, use **Add source** beside **Add another Confluence source**.
82+
After an admin allows Confluence, open **Integrations** in the main sidebar and select **Connect account**. If there is no source yet, enter **Confluence Domain** and **Space Keys**, then select **Connect** and authorize your account. For another site or space scope, use **Add source** beside **Add another Confluence source**.
8383

84-
An admin can open the resulting source under **Settings → Sources → Confluence → Sources** and use **Settings** to adjust its filters. **Account for browsing** helps populate the space picker; it does not connect that account for Search. Manual space keys work without a browsing account.
84+
An admin can open **Settings → Sources**, select **Manage** beside **Confluence**, and open the source's **Settings** tab to adjust its filters. **Account for browsing** helps populate the space picker; it does not connect that account for Search. Manual space keys work without a browsing account.
8585

8686
## Using a service account
8787

@@ -168,7 +168,7 @@ Existing organization members see the configured Confluence source and their own
168168

169169
With a central account, Sim applies space access together with the page's restrictions and inherited ancestor restrictions. Group membership is refreshed in the background. With member accounts, each person's provider listing determines the pages available to them. A Sim organization admin does not automatically receive access to every Confluence document.
170170

171-
New content and permission changes require a sync and processing before Search reflects them. Open **Settings → SourcesConfluence → Sources → [source]** to inspect **Documents**, edit **Settings**, or review **Sync history**. If your own account needs authorization again, use **Reconnect** in the main Integrations page. Where available, the provider's **Accounts → Request connections** sends account connection requests; these do not invite people to the Sim organization.
171+
New content and permission changes require a sync and processing before Search reflects them. Open **Settings → Sources**, select **Manage** beside **Confluence**, then open the source to inspect **Documents**, edit **Settings**, or review **Sync history**. If your own account needs authorization again, use **Reconnect** in the main Integrations page. Where available, the provider's **Accounts → Request connections** sends account connection requests; these do not invite people to the Sim organization.
172172

173173
## Troubleshooting
174174

apps/docs/content/docs/search/connect-your-account.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Image } from '@/components/ui/image'
99

10-
Your admin adds the integration and can configure shared source filters. You connect your own account so Sim can establish what you are allowed to search. Admins connect their own accounts through the same flow.
10+
Your admin allows the integration and can configure shared source filters. You connect your own account so Sim can establish what you are allowed to search. Admins connect their own accounts through the same flow.
1111

1212
<Steps>
1313
<Step>
@@ -21,7 +21,7 @@ Accept your Sim organization invitation or sign in through your organization's S
2121

2222
## Open Integrations
2323

24-
Open **Integrations** in the main sidebar, find the provider or source, and select **Connect account**. Your first connection may ask for a GitHub repository, Confluence domain and space keys, or Jira domain and project keys. Enter the required fields and select **Connect**. If the provider is missing, ask an organization admin to add it under **Settings → Sources**.
24+
Open **Integrations** in the main sidebar, find the provider or source, and select **Connect account**. Your first connection may ask for a GitHub repository, Confluence domain and space keys, or Jira domain and project keys. Enter the required fields and select **Connect**. If the provider is missing, ask an organization admin to turn it on under **Settings → Sources → Allowed in Sim Search**.
2525

2626
Use **Add source** beside **Add another [provider] source** when you need another supported repository, site, or project scope. Connecting an existing source does not ask you to configure it again.
2727

@@ -72,7 +72,7 @@ An account connection request does not invite you into the Sim organization. You
7272

7373
Select **Your accounts** on the main Integrations page to open your personal **Connected accounts** settings. Use **Reconnect** to renew an organization account connection or **Disconnect** to withdraw it. Disconnecting stops that account from being used for organization indexing and workflows, and removes Search access that depends on it.
7474

75-
Admins can select **Manage sources** to open organization setup, then open an integration's **Sources** and **Accounts** tabs. This does not grant the admin access to every document.
75+
Admins can select **Manage sources** to open organization setup, then select **Manage** beside an integration to open its **Sources** and **Accounts** tabs. This does not grant the admin access to every document.
7676

7777
## If you get stuck
7878

@@ -85,7 +85,7 @@ Admins can select **Manage sources** to open organization setup, then open an in
8585
| **Verify email** | Verify your Sim email, then reopen the connection link. |
8686
| Expired or cancelled authorization | Return to the original connection page and start again. If the invitation itself expired, ask the admin for a new request. |
8787
| Access revoked | Ask the organization admin to restore your account contribution access before reconnecting. |
88-
| Needs admin attention | Ask your admin to open **Settings → Sources[integration] → Sources → [source]** to inspect its error. |
88+
| Needs admin attention | Ask your admin to open **Settings → Sources**, select **Manage** beside the integration, and open the source to inspect its error. |
8989

9090
<Callout type="info">
9191
Your Sim role does not override document access at the source. Connecting a different account or receiving a Search link does not share someone else's mailbox, private calendar, or restricted documents with you.

apps/docs/content/docs/search/github.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ In the App's sidebar, choose **Install App**, select the target account, and gra
102102

103103
### Open GitHub setup
104104

105-
As a Sim organization admin, open **Settings → Sources → Add integration** and choose **GitHub**. On its **Sources** tab, select **Add source**. If GitHub is already listed, open it directly.
105+
Open **Settings → Sources** and turn on **GitHub** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**.
106106

107107
</Step>
108108
<Step>
@@ -131,7 +131,7 @@ You can instead select an existing account under **Sync documents with** to supp
131131

132132
Open **Integrations** in the main sidebar, select **Connect account** on the GitHub source, and authorize the App. Teammates repeat this step after joining the Sim organization. For private repositories, both the person's account and the App installation must have access. GitHub also permits App user tokens to read public repositories without an installation; see [GitHub's permission rules](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app).
133133

134-
With **Connected members**, indexing begins after someone connects. A dedicated indexing account can start syncing immediately; each teammate still connects before searching. Open **Settings → SourcesGitHub → Sources → [source]** to inspect **Documents**, edit **Settings**, or review **Sync history**.
134+
With **Connected members**, indexing begins after someone connects. A dedicated indexing account can start syncing immediately; each teammate still connects before searching. Open **Settings → Sources**, select **Manage** beside **GitHub**, then open the source to inspect **Documents**, edit **Settings**, or review **Sync history**.
135135

136136
Use **GitHub → Accounts → Request connections** to send provider-specific connection requests. These requests do not grant organization membership. For another repository, add another source; members can also use **Add another GitHub source** in the main Integrations page.
137137

apps/docs/content/docs/search/gitlab.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The token must read the project, users, inherited project membership, instance s
4949

5050
### Configure the source in Sim
5151

52-
Open **Settings → Sources → Add integration** and choose **GitLab**. On its source list, select **Add source**. If GitLab is already listed, open it directly. Paste the **Personal Access Token**, enter your **Host** and **Project**, and choose the content to index.
52+
Open **Settings → Sources** and turn on **GitLab** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**. Paste the **Personal Access Token**, enter your **Host** and **Project**, and choose the content to index.
5353

5454
| Field | What to enter |
5555
|---|---|
@@ -74,7 +74,7 @@ Select **Connect & Sync**. Sim validates the token and source policy, then start
7474

7575
Invite teammates to the Sim organization using their verified work email. Sim matches that email against the GitLab directory and applies project, feature, and confidential-issue permissions. No GitLab **Connect account** step is required.
7676

77-
Admins open **Settings → Sources → GitLab → [source]** to inspect **Documents**, edit **Settings**, or review **Sync history**. GitLab has no personal **Accounts** tab. Permission and membership changes are picked up during background refreshes.
77+
Admins open **Settings → Sources**, select **Manage** beside **GitLab**, then open the source to inspect **Documents**, edit **Settings**, or review **Sync history**. GitLab has no personal **Accounts** tab. Permission and membership changes are picked up during background refreshes.
7878

7979
</Step>
8080
</Steps>

apps/docs/content/docs/search/gmail.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ These steps require a Sim organization admin.
1818
<Steps>
1919
<Step>
2020

21-
### Add Gmail
21+
### Set up Gmail
2222

23-
Open **Settings → Sources → Add integration** and choose **Gmail**. On its **Sources** tab, select **Add source**. If Gmail is already listed, open it directly. Gmail uses member accounts; there is no domain-wide or service-account crawl in Search.
23+
Open **Settings → Sources** and turn on **Gmail** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**. Gmail uses member accounts; there is no domain-wide or service-account crawl in Search.
2424

2525
</Step>
2626
<Step>
@@ -51,7 +51,7 @@ Teammates follow these same steps after joining the organization. Once an admin
5151

5252
## Source options
5353

54-
An admin opens **Settings → SourcesGmail → Sources → [source]Settings** to change these options. Filters apply separately to each connected mailbox. **Documents** shows indexed threads and **Sync history** shows recent runs.
54+
An admin opens **Settings → Sources**, selects **Manage** beside **Gmail**, and opens the source's **Settings** tab to change these options. Filters apply separately to each connected mailbox. **Documents** shows indexed threads and **Sync history** shows recent runs.
5555

5656
| Option | Behavior |
5757
| --- | --- |

apps/docs/content/docs/search/google-calendar.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ These steps require a Sim organization admin.
1818
<Steps>
1919
<Step>
2020

21-
### Add Google Calendar
21+
### Set up Google Calendar
2222

23-
Open **Settings → Sources → Add integration** and choose **Google Calendar**. On its **Sources** tab, select **Add source**. If it is already listed, open it directly. Search uses member accounts; an admin or service account cannot connect on behalf of everyone.
23+
Open **Settings → Sources** and turn on **Google Calendar** under **Allowed in Sim Search**. Select **Set up** (or **Manage** if sources already exist), then **Add source**. Search uses member accounts; an admin or service account cannot connect on behalf of everyone.
2424

2525
</Step>
2626
<Step>
@@ -53,11 +53,11 @@ Keep the default date range for the previous and next 30 days. **More options**
5353
2. In the connection tab, choose the Google account whose verified email matches your Sim email. Grant the requested permissions.
5454
3. Return to Integrations to see indexing status and your searchable document count.
5555

56-
Teammates repeat only these connection steps after joining the organization. They do not need to configure the source. An admin can send connection requests from **Settings → SourcesGoogle CalendarAccounts → Request connections**. These requests do not grant organization membership. Connecting Gmail or Google Drive does not replace the Calendar connection.
56+
Teammates repeat only these connection steps after joining the organization. They do not need to configure the source. An admin can send connection requests from **Settings → Sources**: select **Manage** beside **Google Calendar**, then **Accounts → Request connections**. These requests do not grant organization membership. Connecting Gmail or Google Drive does not replace the Calendar connection.
5757

5858
## Source options
5959

60-
An admin opens **Settings → SourcesGoogle Calendar → Sources → [source]Settings** to change these options. **Documents** shows indexed events and **Sync history** shows recent runs.
60+
An admin opens **Settings → Sources**, selects **Manage** beside **Google Calendar**, and opens the source's **Settings** tab to change these options. **Documents** shows indexed events and **Sync history** shows recent runs.
6161

6262
| Option | Behavior |
6363
| --- | --- |

0 commit comments

Comments
 (0)