Bitbucket Enterprise Sync

Connect ReadMe to Bitbucket Cloud to keep your documentation in sync with your codebase. Enterprise groups use the same ReadMe Sync app and verification code as the standard connector.

Connect Bitbucket to ReadMe

Group admins connect repositories from the group dashboard. Go to Git Connection, find the child project in the table, and click Connect. Choose Bitbucket, then follow the steps in Bitbucket Sync. The verification code you generate there belongs to that child project, so connect each child separately.

If your group lets child projects manage their own connection, a project admin on the child can do the same thing from the child's Settings > Git Connection.

Repository Requirements

Each child project can only sync to one repository, and that repository must be completely empty before connecting. A repository can't be shared between child projects. You can add and remove files after setup is complete.

The app is installed once per Bitbucket workspace, so children whose repositories live in the same workspace share one installation.

Permission Requirements

• A Bitbucket workspace admin installs the ReadMe Sync app.
• A repository admin enters the verification code.
• The app requests read and write access to repositories, plus read access to the workspace.

Disconnecting

Group admins can disconnect a child from the group dashboard. Go to Git Connection, click Connected on the child's row, then on the Docs repository card click Connected and choose Disconnect Repository. Don't use Disconnect All Projects under Existing Connections, which removes the whole connection for every child. Content stays in the repository, and that repository can't be reconnected. See Disconnecting.