Skip to main content
Git 让你可以控制并跟踪文件的变更。Git 是 docs-as-code 工作流中的首选版本控制系统,在这种工作流中,你会像管理其他任何代码库一样管理文档。 Web 编辑器会替你处理 Git 操作。理解几个关键概念有助于你更好地发挥编辑器的作用,并更高效地与团队协作。

Git 为文档做什么

Git 会跟踪对文档所做的每一次更改。它会记录更改了什么、是谁更改的、何时更改的,以及为什么更改。这意味着你可以:
  • 查看任意页面的完整历史记录。
  • 通过回退到先前版本来撤销更改。
  • 在不影响线上站点的情况下进行更新。
  • 在更改上线之前先进行审查。
你的文档存储库是构成文档站点的文件及其历史记录的集合。Web 编辑器会连接到此存储库,以读取并更新你的内容。

关键概念

这些是你在使用 Web 编辑器时最常接触到的 Git 概念。
在特定时间点保存的更改快照。每次提交都包含一条描述更改内容的消息,并在你的项目历史中创建一条永久记录。当你保存更改时,Web 编辑器会创建一次提交。
存储库中的一条独立工作线路,有时称为 功能分支(feature branch)你的在线文档是从一个 部署用分支 构建的,通常名为 main。其他分支让你可以独立进行修改。在将某个分支通过拉取请求合并到部署用分支之前,该分支上的任何内容都不会影响你的线上站点。当你创建一个分支时,Web 编辑器会在你的存储库中创建一个新的分支。你可以通过工具栏中的分支下拉菜单在不同分支之间切换。
用于构建你的线上文档站点的分支,通常名为 main。合并到该分支的更改会自动部署到你的站点。
一个将更改从一个分支合并到另一个分支的提案。拉取请求可以让你的团队在更改上线之前进行审查和讨论。当你在功能分支上发布更改时,Web 编辑器会创建一个拉取请求。你的团队会在 Git 提供商(GitHub 或 GitLab)中审查并合并该拉取请求。
将一个分支中的更改合并到另一个分支中。在你的团队审查并批准拉取请求之后,合并该分支会把你的更改纳入部署用分支并发布。
当两个人以不同方式修改了文件的同一部分时就会发生冲突。编辑器会帮助你解决在各个分支上出现的任何冲突。
显示文件两个版本之间差异的对比视图。在审查拉取请求时,差异会精准高亮出发生了哪些更改。

编辑器如何映射到 Git

你在网页版编辑器中执行的每一个操作,都对应一次 Git 操作。
你在编辑器中的操作背后对应的 Git 操作
打开文件从你的存储库中拉取最新版本
保存更改创建一个 提交(commit),即项目历史中你的更改快照
创建 branch创建一个 branch,一条独立的开发线路,不会影响你的线上站点,除非你选择发布它
在部署用分支上发布直接推送你的提交,这会触发一次部署
在功能 branch 上发布创建一个 拉取请求(PR;亦称“合并请求”/Merge Request),提议将你的更改合并到部署用分支