Bitbucket Cloud 需要 Enterprise 套餐。
bitbucket.org 上的 Bitbucket Cloud 仓库。Bitbucket Data Center、Slack agent 和 automations 不支持 Bitbucket 仓库。
要求
- 一个 Bitbucket Cloud 账户
- 在你要连接的仓库中创建 webhook 的权限
- 你的 Mintlify 组织的管理员访问权限
- 你的仓库中有一个
docs.json文件
设置新的 Bitbucket 连接
1
选择 Bitbucket 作为提供商
- 在 Git Settings 页面,选择 Connect to Bitbucket。
- 点击 Continue。
2
迁移 Mintlify 托管的内容
如果你目前将内容托管在 Mintlify 管理的仓库中,请将其下载为 zip 文件。解压 zip 内容并将文件推送到你的 Bitbucket 仓库。如果你的内容已经在 Bitbucket 中,请点击 Continue setup。
3
授权 Bitbucket
- 点击 Connect Bitbucket。
- Bitbucket 会打开一个新页面,用于授权 Mintlify 访问你的 Bitbucket 账户。请授权 Mintlify 访问你要连接的仓库。
4
配置仓库
输入以下值:
- Workspace:拥有该仓库的 Bitbucket 工作区的 slug。例如,在
https://bitbucket.org/acme/docs中,acme是工作区 slug。 - Repository:仓库的 slug。例如,在
https://bitbucket.org/acme/docs中,docs是仓库 slug。 - Deploy branch:发布到你的正式文档站点的分支,例如
main。
5
配置内容目录(可选)
- 如果你的
docs.json文件位于子目录中,请在 Git 设置页面启用 Docs are in a subdirectory。 - 输入包含你的
docs.json文件的目录路径。例如,如果你的docs.json位于apps/docs/目录,请输入apps/docs。
6
连接仓库
- 点击 Connect。
- 确认更改。Mintlify 会验证已授权的 Bitbucket 账户可以访问你的仓库,并注册用于触发部署和拉取请求预览的 webhook。
更新现有连接
- 前往你的 Mintlify 控制台的 Git Settings 页面。
- 展开 Bitbucket OAuth 部分。
- 启用或禁用单个仓库。禁用某个仓库会移除其 Mintlify webhook。
配置多个仓库
故障排查
仓库未授权
仓库未授权
如果 Mintlify 报告没有已连接的安装可以访问你的仓库,请检查以下内容:
- 工作区和仓库值使用了正确的 slug,而不是显示名称。
- 已连接的 Bitbucket 账户具有访问该仓库所需的权限。
- 你在 Mintlify Git 设置的 Bitbucket OAuth 部分中启用了该仓库。
部署未自动触发
部署未自动触发
在 Bitbucket 中,打开 Repository settings > Webhooks,验证是否存在名为 Mintlify 的活动 webhook。如果缺失,请返回你的 Mintlify Git 设置,在 Bitbucket OAuth 下禁用该仓库,然后再次启用。验证你的 Mintlify Git 设置中的分支与你推送更改的 Bitbucket 分支一致。
拉取请求预览未出现
拉取请求预览未出现
验证 Mintlify webhook 处于活动状态并包含拉取请求事件。如果你在连接仓库后更改了 Bitbucket 权限,请重新连接你的 Bitbucket 账户并再次启用该仓库。