Skip to content

Commit 1be4328

Browse files
authored
improvement(search): simplify integration setup and connection actions (#7761)
* improvement(search): simplify integration connections and sync actions * improvement(integrations): align setup controls and refresh search guides * fix(search): expose incomplete connection checks and update setup tests
1 parent 3b8ad1a commit 1be4328

86 files changed

Lines changed: 2909 additions & 1597 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ Open **More options** for content type, labels, and metadata tags. The default i
4949

5050
### Sync and connect your identity
5151

52-
Select **Connect & Sync** to start indexing. Then open **Integrations** in the main sidebar and select **Connect** on the Confluence source. Authorize the configured site using the Atlassian email matching your verified Sim email.
52+
Select **Connect & Sync** to start indexing. Then open **Integrations** in the main sidebar and select **Connect** for Confluence. Authorize the configured site using the Atlassian email matching your verified Sim email.
5353

54-
Each teammate completes this identity connection. Existing authorized accounts may already be connected. Integrations shows indexing status and your searchable document count.
54+
Each teammate completes this identity connection. An existing authorized account may already cover the site. Confluence appears once in Integrations, even with multiple sites; **Connect** or **Reconnect** appears when another authorization is needed.
5555

5656
</Step>
5757
</Steps>
@@ -60,22 +60,22 @@ For workspace Search, start from **Search → Add source**. Available methods de
6060

6161
## Connect member accounts
6262

63-
After an admin allows Confluence, open **IntegrationsConnect**. For an existing source, authorize your account; you do not choose its spaces again.
63+
After an admin configures Confluence, open **Integrations** and select **Connect** beside Confluence. Authorize your account; you do not enter the site's domain or choose its spaces again.
6464

65-
If no source exists, or you choose **Connect a different site or content scope**:
65+
If Confluence is allowed but no source exists, select **Connect** beside Confluence. To add another site later, open the Confluence row’s actions menu (****) and select **Add Confluence site**:
6666

67-
1. Under **Your account**, select a saved account or choose **Connect account**. Authorize using the Atlassian email matching your verified Sim email.
68-
2. Enter the hostname under **Atlassian site**, then choose **Spaces**. Use **All** in the dropdown for the complete current list, or **Enter keys manually** for comma-separated keys. You can select up to 1,000 spaces in this form.
67+
1. Open **Your account** and select a saved account or **Connect Confluence account**. Authorize using the Atlassian email matching your verified Sim email.
68+
2. Enter the hostname under **Atlassian site**, then choose **Spaces**. Use **All** in the dropdown for the complete current list, or the arrows beside **Spaces** to enter comma-separated keys. You can select up to 1,000 spaces in this form.
6969
3. Select **Connect & Sync**. Sim saves the selected scope and starts indexing with your account.
7070

7171
<Image className="mx-auto h-auto w-full max-w-md"
7272
src="/static/search/confluence-personal-setup.png"
7373
alt="Confluence personal source setup with a saved account, Atlassian site, and selected spaces"
74-
width={501}
75-
height={502}
74+
width={515}
75+
height={345}
7676
/>
7777

78-
Admins manage these sources under **Settings → Sources → Confluence**. When configuring a member-account connection, an **Account for browsing** populates the space picker; a saved personal Search account can be reused here. Choosing a browsing account does not enroll it for Search. Manual space keys work without a browsing account.
78+
To configure this method as an admin, open **Settings → Sources → Confluence → Add Confluence site** and choose **Sync using → Member accounts**. Enter the site and spaces, then select **Add Confluence site**. **Account for browsing** populates the space picker but does not connect that person to Search; manual space keys work without a browsing account. Teammates then connect from **Integrations**.
7979

8080
## Using a service account
8181

@@ -103,7 +103,7 @@ read:group:confluence
103103
Use all 12 scopes for account validation, pickers, content, permissions, and directory reads. Central indexing does not need write scopes.
104104

105105
4. Review and create the token, then copy it. Atlassian shows it only once.
106-
5. In Sim's source form, use **Service account** to add a service account. Paste the **API token**, enter **Site domain** (hostname only), and select **Add service account**. Continue in the source form with the same domain.
106+
5. In Sim's source form, open **Service account → Add service account**. Paste the **API token**, enter **Site domain** (hostname only), and select **Add service account**. Continue in the source form with the same domain.
107107

108108
<Image className="mx-auto h-auto w-full max-w-md"
109109
src="/static/credentials/atlassian/admin-auth-type-picker.png"
@@ -132,6 +132,8 @@ Central sources combine space permissions, page and ancestor restrictions, and g
132132

133133
Open **Settings → Sources → Confluence**, then a source's **Documents**, **Settings**, or **Sync history**. Invite teammates through **Settings → Members → Invite** or SSO, then have them connect through **Integrations**. **People → Request connections** only requests a provider connection; it does not invite people to the organization.
134134

135+
Syncing runs automatically. Admins can use **Sync now** for an immediate update, **Pause syncing** to stop scheduled syncs, or **Resume syncing** to restart them. **Full resync**, available for service-account connections, fetches unchanged content again and asks for confirmation. Successful manual syncs have a one-minute cooldown; failed syncs can be retried immediately.
136+
135137
## Troubleshooting
136138

137139
| Problem | What to check |
@@ -145,7 +147,7 @@ Open **Settings → Sources → Confluence**, then a source's **Documents**, **S
145147
| Embedded content is missing | Index the referenced page separately; remote macro output is excluded. |
146148
| **Reconnect** or email mismatch | Authorize with the Atlassian account matching your verified Sim email and grant all requested permissions. |
147149

148-
Open a missing page as the affected teammate. **Share → General access** shows its restrictions; a space admin can also inspect **Space settings → Content → Restricted**. On Premium, **Inspect permissions → Can view** helps locate denied access. Resolve the restriction, then sync again. See Atlassian's [content access](https://support.atlassian.com/confluence-cloud/docs/add-or-remove-page-restrictions/) and [permission inspection](https://support.atlassian.com/confluence-cloud/docs/inspect-a-users-permissions/) guides.
150+
Open a missing page as the affected teammate, check its space and page restrictions, then sync again after correcting access. See Atlassian's [content access](https://support.atlassian.com/confluence-cloud/docs/add-or-remove-page-restrictions/) and [permission inspection](https://support.atlassian.com/confluence-cloud/docs/inspect-a-users-permissions/) guides.
149151

150152
## Self-hosted operator setup
151153

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,13 @@ For a central Google source, use your primary Workspace email and open **Search*
2323

2424
## Open Integrations
2525

26-
Open **Integrations** in the main sidebar, find the provider or source, and select **Connect**. First-time setup can also ask which content to index. For [Confluence](/search/confluence) and [Jira](/search/jira), connect your Atlassian account first, then choose the site and spaces or projects and select **Connect & Sync**. [GitHub](/search/github) asks for a repository. If the provider is missing, ask an organization admin to add it under **Settings → Sources → Add source**.
26+
Open **Integrations** in the main sidebar, find the integration, and select **Connect**. If an admin has configured its content, you only authorize your account. If no source exists yet, [Confluence](/search/confluence) and [Jira](/search/jira) ask you to connect your Atlassian account, choose the site and spaces or projects, and select **Connect & Sync**. [GitHub](/search/github) asks for a repository. If the provider is missing, ask an organization admin to add it under **Settings → Sources → Add source**.
2727

28-
To connect another supported repository, site, or project scope, find the provider row labeled **Connect a different site or content scope** and select **Connect**. Connecting an existing source does not ask you to configure it again.
28+
Each integration appears once. Sources that share your account authorization reuse that connection; adding another repository does not require reconnecting. **Connect** appears when authorization is missing, and **Reconnect** appears when an existing account needs renewal. A sync failure alone does not require reconnecting. To add different content, open the row’s actions menu (****) and select **Add repository**, **Add Confluence site**, or **Add projects**.
2929

30-
<Image className="mx-auto h-auto w-full max-w-xl" src="/static/search/connect-account.png" alt="Organization Integrations with search, personal connections, and Connect actions" width={704} height={495} />
30+
If you see **More connections to check**, select **Check connections** to check the next set of sources. Sim shows **Connect** or **Reconnect** when it finds an account that needs authorization.
31+
32+
<Image className="mx-auto h-auto w-full max-w-xl" src="/static/search/connect-account.png" alt="Organization Integrations with search, personal connections, and Connect actions" width={692} height={435} />
3133

3234
</Step>
3335
<Step>
@@ -43,7 +45,7 @@ The authorization tab closes when the connection completes and Integrations upda
4345

4446
## Start searching
4547

46-
The source row shows indexing status and how many documents are available to you. Open **Search** in the organization sidebar and search for something you can already open in the source. Use **Home** to ask the assistant about your connected documents. The first sync may take time, especially for large accounts.
48+
Your integration row shows its connection and indexing status. Admins manage individual repositories, sites, and other content under **Settings → Sources**. Open **Search** in the organization sidebar and search for something you can already open in the source. Use **Home** to ask the assistant about your connected documents. The first sync may take time, especially for large accounts.
4749

4850
</Step>
4951
</Steps>
@@ -58,9 +60,9 @@ For a source configured inside a workspace, join that workspace and connect thro
5860
| GitHub App installation | Connect GitHub once for this Sim organization. The App handles indexing; your account establishes which repositories you may search. |
5961
| Confluence service account | Connect Confluence to verify your identity; the service account handles the crawl. |
6062
| Google Workspace service account (Gmail, Calendar, Drive) | No personal connection is needed for that source. Your verified Sim email identifies your mailbox and calendar view, or is matched to Drive permissions. |
61-
| GitLab instance administrator | No personal connection is needed. Your verified Sim email must match the confirmed primary GitLab email. |
63+
| GitLab | No personal connection is needed. For an administrator token, your verified Sim email must match your confirmed primary GitLab email. For a non-admin token, it must match the uploaded user mapping and have a project grant. |
6264

63-
Gmail, Calendar, and Drive are separate Search sources. Connecting one Google service does not connect all of them. A central source can be searchable without a personal connection row in **Integrations**.
65+
Gmail, Calendar, and Drive are separate Search sources. Connecting one Google service does not connect all of them. Central Google and GitLab sources remain searchable without a personal account connection.
6466

6567
## If you received a connection request
6668

@@ -72,10 +74,14 @@ An account connection request does not invite you into the Sim organization. You
7274

7375
## Manage your connected accounts
7476

75-
On the main **Integrations** page, use **Reconnect** beside an expired connection to renew it. To withdraw an account, open its row's actions menu and select **Disconnect**, then confirm. If several accounts are connected, choose the account to disconnect. Disconnecting stops that account from being used for organization indexing and workflows, and removes Search access that depends on it.
77+
On the main **Integrations** page, select **Reconnect** beside the integration if your account has expired. To withdraw an account, open its actions menu and select **Disconnect**, then confirm. If several accounts are connected, choose the account to disconnect. Disconnecting stops that account from being used for organization indexing and workflows, and removes Search access that depends on it.
7678

7779
Admins manage setup from **Settings → Sources**. Open an integration, then its connection to see **Documents**, **Settings**, and **Sync history**. **People** shows account contributors across integrations and supports filtering by integration. This does not grant the admin access to every document.
7880

81+
Syncing runs automatically. Admins can use **Sync now** when they need an update; another manual run is available 60 seconds after a successful sync finishes. Failed or partial runs can be retried immediately. The connection header also offers **Pause syncing** or **Resume syncing**, and **Remove connection**. Where supported, **Full resync** fetches and reindexes all content and asks for confirmation first.
82+
83+
Removing a Search connection also removes its indexed documents from Sim. The originals remain in the connected app.
84+
7985
## If you get stuck
8086

8187
| Status | What to do |

0 commit comments

Comments
 (0)