Skip to content

docs: improve connection docs to be more clear #982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
brendan-kellam merged 1 commit into from
Mar 5, 2026
Merged

docs: improve connection docs to be more clear #982

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/docs/connections/ado-cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,11 @@ Next, provide the access [token](/docs/configuration/config-file#tokens) via an
// note: this env var can be named anything. It
// doesn't need to be `ADO_TOKEN`.
"env": "ADO_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["organizationName/projectName/repoName"],
// "orgs": ["organizationName"],
// "projects": ["organizationName/projectName"]
}
```

Expand Down
7 changes: 5 additions & 2 deletions docs/docs/connections/ado-server.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,11 @@ Next, provide the access [token](/docs/configuration/config-file#tokens) via an
// note: this env var can be named anything. It
// doesn't need to be `ADO_TOKEN`.
"env": "ADO_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["collectionName/projectName/repoName"],
// "orgs": ["collectionName"],
// "projects": ["collectionName/projectName"]
}
```

Expand Down
21 changes: 15 additions & 6 deletions docs/docs/connections/bitbucket-cloud.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,8 +102,11 @@ In order to index private repositories, you'll need to provide authentication cr
// note: this env var can be named anything. It
// doesn't need to be `BITBUCKET_TOKEN`.
"env": "BITBUCKET_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["myWorkspace/myRepo"],
// "workspaces": ["myWorkspace"],
// "projects": ["myProject"]
}
```

Expand All @@ -130,8 +133,11 @@ In order to index private repositories, you'll need to provide authentication cr
// note: this env var can be named anything. It
// doesn't need to be `BITBUCKET_TOKEN`.
"env": "BITBUCKET_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["myWorkspace/myRepo"],
// "workspaces": ["myWorkspace"],
// "projects": ["myProject"]
}
```

Expand Down Expand Up @@ -164,8 +170,11 @@ In order to index private repositories, you'll need to provide authentication cr
// note: this env var can be named anything. It
// doesn't need to be `BITBUCKET_TOKEN`.
"env": "BITBUCKET_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["myWorkspace/myRepo"],
// "workspaces": ["myWorkspace"],
// "projects": ["myProject"]
}
```

Expand Down
14 changes: 10 additions & 4 deletions docs/docs/connections/bitbucket-data-center.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,11 @@ In order to index private repositories, you'll need to provide a [HTTP Access To
// note: this env var can be named anything. It
// doesn't need to be `BITBUCKET_TOKEN`.
"env": "BITBUCKET_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["myProject/myRepo"],
// "projects": ["myProject"],
// "all": true
}
```

Expand Down Expand Up @@ -134,8 +137,11 @@ In order to index private repositories, you'll need to provide a [HTTP Access To
// note: this env var can be named anything. It
// doesn't need to be `BITBUCKET_TOKEN`.
"env": "BITBUCKET_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["myProject/myRepo"],
// "projects": ["myProject"],
// "all": true
}
```

Expand Down
5 changes: 3 additions & 2 deletions docs/docs/connections/gerrit.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ To connect to a gerrit instance, provide the `url` property to your config:
```json
{
"type": "gerrit",
"url": "https://gerrit.example.com"
// .. rest of config ..
"url": "https://gerrit.example.com",
// Specify which projects to sync using glob patterns:
"projects": ["project1/**"]
}
```

Expand Down
14 changes: 10 additions & 4 deletions docs/docs/connections/gitea.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,11 @@ Next, provide the access token via an environment variable [token](/docs/configu
// note: this env var can be named anything. It
// doesn't need to be `GITEA_TOKEN`.
"env": "GITEA_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["my-org/myRepo"],
// "orgs": ["my-org"],
// "users": ["my-user"]
}
```

Expand All @@ -116,8 +119,11 @@ To connect to a custom Gitea deployment, provide the `url` property to your conf
```json
{
"type": "gitea",
"url": "https://gitea.example.com"
// .. rest of config ..
"url": "https://gitea.example.com",
// At least one of the following is required to specify which repos to sync:
"repos": ["my-org/myRepo"],
// "orgs": ["my-org"],
// "users": ["my-user"]
}
```

Expand Down
21 changes: 15 additions & 6 deletions docs/docs/connections/github.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,8 +172,11 @@ In order to index private repositories, you'll need to authenticate with GitHub.
// note: this env var can be named anything. It
// doesn't need to be `GITHUB_TOKEN`.
"env": "GITHUB_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["my-org/myRepo"],
// "orgs": ["my-org"],
// "users": ["my-user"]
}
```
</Step>
Expand Down Expand Up @@ -203,8 +206,11 @@ In order to index private repositories, you'll need to authenticate with GitHub.
// note: this env var can be named anything. It
// doesn't need to be `GITHUB_TOKEN`.
"env": "GITHUB_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which repos to sync:
"repos": ["my-org/myRepo"],
// "orgs": ["my-org"],
// "users": ["my-user"]
}
```
</Step>
Expand All @@ -222,8 +228,11 @@ To connect to a GitHub host other than `github.com`, provide the `url` property
```json
{
"type": "github",
"url": "https://github.example.com"
// .. rest of config ..
"url": "https://github.example.com",
// At least one of the following is required to specify which repos to sync:
"repos": ["my-org/myRepo"],
// "orgs": ["my-org"],
// "users": ["my-user"]
}
```

Expand Down
16 changes: 12 additions & 4 deletions docs/docs/connections/gitlab.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,8 +129,12 @@ Next, provide the PAT via an environment variable [token](/docs/configuration/co
// note: this env var can be named anything. It
// doesn't need to be `GITLAB_TOKEN`.
"env": "GITLAB_TOKEN"
}
// .. rest of config ..
},
// At least one of the following is required to specify which projects to sync:
"projects": ["my-group/myProject"],
// "groups": ["my-group"],
// "users": ["my-user"],
// "all": true (self-managed only)
}
```

Expand All @@ -151,8 +155,12 @@ To connect to a GitLab host other than `gitlab.com`, provide the `url` property
```json
{
"type": "gitlab",
"url": "https://gitlab.example.com"
// .. rest of config ..
"url": "https://gitlab.example.com",
// At least one of the following is required to specify which projects to sync:
"projects": ["my-group/myProject"],
// "groups": ["my-group"],
// "users": ["my-user"],
// "all": true
}
```

Expand Down