审阅更改
在更改上线前进行预览、与团队共享、请求审阅,并在编辑器中合并 pull request。
在更改进入你的线上站点之前先进行预览、请求审阅你的 pull request,并在编辑器中合并它。
实时预览会在你编辑时渲染站点,无需构建步骤。在 Site 标签页中,点击顶部栏中的 Preview。预览会全屏打开。点击 Refresh preview 可重新加载,或点击 Close preview 返回编辑器。若要改为在新的浏览器标签页中打开预览,请开启 Open live preview in new tab。
若要编辑站点设置并查看其对内容的影响,请点击预览工具栏中的 Site settings,然后选择一个配置分区。
若要在预览旁边打开智能体,请点击预览工具栏中的 Ask agent。只有 editors 和 admins 才能在实时预览中使用智能体。
实时预览仅适用于公开站点以及受 Mintlify 认证保护的站点。
当你的 feature branch 存在 pull request 时,Mintlify 会构建一个预览部署:一个临时 URL,你的更改会在其中以发布后完全一致的方式呈现。每当编辑器向该分支提交新更改时,预览都会重新构建。该 URL 由你项目的子域名和分支名称组合而成:<subdomain>-<branch-name>.mintlify.site。你可以在 Mintlify 机器人的 pull request 评论中找到确切的 URL。
预览 URL 默认可公开访问。若要将访问权限限制为你的 Mintlify 组织成员,请在仪表板的常规页面的 Previews 分区中启用预览认证。更多信息请参阅限制预览部署的访问权限。
| 功能 | 实时预览 | 预览部署 |
|---|---|---|
| 速度 | 即时 | 需要构建 |
| 访问方式 | 在编辑器内 | 可共享的 URL |
| 适用场景 | 编辑时审阅更改 | 与团队共享以供审阅 |
| 可用时长 | 编辑器打开期间 | 只要该分支存在 |
若要把同事引导到分支上的某个特定页面,请点击页面右上角的 More options,然后点击 Copy link。任何有权访问你 Mintlify 组织的人都可以在自己的编辑器会话中打开该链接。
当你的分支存在 pull request 时,发布菜单会显示其已更改的文件和审阅状态,例如 Draft in progress、Review required、Changes requested 或 Approved。点击 View request 可在你的 Git 提供方中打开该 pull request。
- 点击顶部栏中的 Publish,然后点击 Request review。这会将 pull request 标记为可供审阅。
- 审阅者在你的 Git 提供方中批准 pull request。
- 点击 Publish,然后点击 Merge and publish。编辑器会合并 pull request,部署你的更改,并把你切换回 deployment branch。
如果 Mintlify 托管你的仓库并且不要求审批,发布菜单会改为显示 Publish,一步完成合并和部署。
在你的 Git 提供方中配置分支保护规则以要求使用 pull request。请参阅 GitHub 帮助中的 About protected branches,或 GitLab 帮助中的 Protected branches。
在发布菜单中点击任意已更改的文件,即可在 diff 视图中将其与已发布版本进行比较。若要退出 diff 视图,请点击顶部栏中的 Viewing changes,或按 Cmd + Shift + D(macOS)或 Ctrl + Shift + D(Windows)。可视化模式会显示可视化 diff,source 模式会显示文本 diff。无法显示 diff 的文件(例如图片或已删除的文件)会出现在列表中,但无法点击。
出现在分支 diff 中的隐藏页面也可以从发布菜单中打开,即使它们并未出现在站点导航中。
pull request 的标题来自你的分支标题。
如果你的分支存在打开的评论线程,Mintlify 会把这些线程的摘要添加到 pull request 描述中。请参阅协作。
当自动化打开 pull request 时,你可以在该自动化的分支上打开编辑器:
- 在 Slack 通知或通知邮件中,点击 View changes。编辑器会在该自动化的分支上以 diff 视图打开,智能体会在旁边打开,并带有该自动化所做工作的上下文。
- 在仪表板的 Automations 页面的 Runs 标签页中,打开某次运行的操作菜单并选择 Open in editor。
若要改为打开该自动化的预览部署,请在该运行上点击 Preview。