Sources

Sources are the GitHub repositories Cactus reads to write a product's help pages, and you choose them in Settings › Sources.

On this page

Connect GitHub

Cactus reads a product's code through the GitHub repositories you connect here. Open Settings › Sources and select Connect GitHub.

Until a GitHub account is connected, the screen shows Not connected under GitHub.

When you select Connect GitHub, a GitHub window opens. The screen waits for that window to report back and then connects, or shows why it did not.

GitHub asks for access to the repositories you choose on GitHub's side. Cactus can read only the repositories that access covers.

Choose the repositories Cactus reads

Once GitHub is connected, select Pick repositories in Sources. A list opens in place of the rows, with a row for each repository your GitHub account has given Cactus.

Select the repositories to read, then select Save. The button stays off until at least one is selected, and the count beside it reads None selected or N selected.

If you pick none and select Save, the screen says Pick at least one repository.

If the list has more than 8 repositories, a Filter repositories box appears above it. A row matches when every word you type appears in its name, ignoring case and accents.

If your repositories belong to more than one owner, a chip for each owner appears above the list, so you can narrow it to one owner.

To read a repository that belongs to someone else, select Fork on GitHub under the list, fork it into your own GitHub account, then pick the fork.

What saving does

Saving replaces the product's repositories with the ones you picked.

A build starts when the set of repositories changed.

A save that adds or changes repositories starts a build.

If the build cannot be started, the save is undone and the screen shows Cactus couldn't start reading these repositories. Try again.

Remove a repository

In Sources, select Remove beside a repository.

Removal waits out an undo window of 4 seconds. Press Remove again, or press Escape while the button has the focus, to keep the repository.

Once removal goes through, Cactus stops reading that repository. It then sends a build.

If a GitHub connection needs attention

What you see

What it means

What to do

A GitHub admin still has to approve this install. You’ll get access once they do.

What it means

GitHub has not approved the install yet, so no repositories are listed.

What to do

Ask a GitHub admin to approve the install on GitHub.

GitHub didn’t confirm access to that installation. Try connecting again.

What it means

GitHub did not confirm the install.

What to do

Select Connect GitHub again.

Couldn’t confirm access with GitHub. Try connecting again.

What it means

Cactus could not confirm access.

What to do

Select Connect GitHub again.

No repositories yet

What it means

GitHub has given Cactus access to no repositories.

What to do

Select Choose repositories on GitHub, then come back to this screen.

Couldn’t reach GitHub

What it means

Cactus could not list GitHub's repositories.

What to do

Select Retry.

Other sources on this screen

Below the GitHub panel, Flag tools lists PostHog and LaunchDarkly. Connect and disconnect them there.

Slack, Discord and Linear connect from their own screens, not from this one.

GitHub stays connected for the whole team, so a connected repository is removed one at a time here, not by disconnecting GitHub.

Related pages