How to connect a source

How-to guide

Add a GitHub, URL, or app source and sync it into the knowledge index without flipping the live site.

Goal

Connect a content source and sync it into the knowledge index so chat and agents can ground answers. This does not make a public site live.

Conditions

  • You are a workspace owner or admin.
  • If the repo is private, you will Connect GitHub first. Public owner/name needs no GitHub login.
  • Confluence, Drive, Slack, and Jira need those OAuth apps configured on the deployment. Until then, Connect reports unconfigured.

Procedure

  1. Open Sources in the dashboard.
  2. If you want a public GitHub repo, type owner/name and add the source.
  3. If you want a private GitHub repo, click Connect GitHub, authorize, then pick from the list.
  4. If you want a URL, add a documentation URL (one origin, bounded crawl).
  5. If you want Confluence, Drive, Slack, or Jira, Connect that provider, then add it.
  6. If you want generated drafts, add DocsGen or OpenAPI. *(see How-to: How to generate a draft docs site)*
  7. Click Sync now, or set the schedule to auto.

Verification

Status is Indexed, Never indexed, Busy, Sync failed, or Paused. Soft skips (already running, short rate limit) show as status. The live public package has not changed.

Failures

  • Sync failed: open the source row for the error and fix hint. Retry Sync now.
  • Provider unconfigured: the deployment is missing that OAuth app. Do not retry until ops sets the client credentials.
  • Private repo without Connect GitHub: fails honestly. Connect GitHub or use a public slug.
  • You expected the public site to change: promote from Sites or push from CI. *(see How-to: How to publish from your pipeline)*
Note
ACL-bearing sources attach a permission key to chunks. The public widget retrieves public content only. Signed-in private chat filters to keys the member may see. *(see Explanation: About grounded answers)*