Sources
A source is a place Workstate reads from: repositories on GitHub, pages in Confluence, issues in Jira, or files you upload. Workstate indexes what it reads so that people and agents can search it. It never changes the original.
Each source belongs to one namespace. Everyone who can reach that namespace can search everything indexed from the source.
What you can connect today
| Source | What Workstate reads | How it connects | Corpus |
|---|---|---|---|
| GitHub | The default branch of each repository you share | The Workstate GitHub App, read-only | code |
| Confluence | The current pages of up to 50 spaces | An Atlassian account's email and API token | wiki |
| Jira | The issues of up to 50 projects, with their comments | An Atlassian account's email and API token | wiki |
| Upload files | Documents, PDFs, Office files, notes and code that you upload | Your browser | code for code, wiki for everything else |
The corpus is the part of the index that a result comes from. An agent can narrow a search to code or wiki. See Search & citations.
GitHubShare repositories through the Workstate GitHub App. Read-only, default branch only.ConfluenceIndex the current pages of Confluence Cloud spaces.JiraIndex Jira Cloud issues with their descriptions and comments.Upload filesPolicies, contracts, runbooks, reports and code, straight from your computer.Sync schedulesHow often sources sync, and how to sync one now.Coming soonSlack, Google Drive and more connectors on the way.
Who can add a source
Owners and admins add sources, change how they sync, and delete them. They also upload and delete files.
Members see every source in the namespace, and they can select Sync now. For a member, the tiles under Add a source are greyed out. Pointing at one shows "Only owners and admins can add sources". See Roles.
Add a source
- In the console, choose a namespace in the switcher at the top of the sidebar. The new source goes into that namespace.
- Open Sources. The page lists the sources of the selected namespace.
- Under Add a source, select Upload files, GitHub, Confluence or Jira.
- Follow the guide for that source.
If a tile is greyed out, point at it to see why.
Source names
Every source has a name of 1 to 64 characters. The name can use letters, digits, spaces, hyphens (-), underscores (_) and dots (.).
For an upload, Confluence or Jira source, the name is also the repository name. Search results show it, and the repo filter matches it. Workstate writes it in lower case, with hyphens for spaces. For example, a source named "Team handbook" is searchable as team-handbook. A GitHub repository keeps its own name.
Before you connect anything
Everyone in the namespace sees everything in it
Workstate has no per-document permissions. Everyone who can reach a namespace can search every source in it, whatever the original system lets them see. Put sensitive material, such as HR or legal files, in a namespace of its own, and give access only to the people who need it. See Permissions.
Secrets in repositories are indexed
Workstate does not look for secrets inside files. A password, token or key committed to a repository you share is indexed, and anyone in the namespace can find it. Remove secrets before you share a repository. See GitHub.
Keep sources up to date
GitHub, Confluence and Jira sources sync once a day by default, and whenever someone selects Sync now. An upload source changes only when someone uploads or deletes files. See Sync schedules.
Deleting a source removes everything indexed from it, its uploaded files and its sync history. You cannot undo a deletion.
More sources
Slack and Google Drive are on the way. See Coming soon.