文档相关的 Git 概念
学习用于文档即代码工作流的 Git 版本控制基础知识，包括仓库、branch、commit 和拉取请求协作。
Git 是一种版本控制系统，可用于跟踪文档的变更并与团队成员协作。借助 Git，你可以查看项目中每个文件在不同时间点发生了哪些变更、是谁在什么时间做出的变更，以及变更的原因。如有需要，也可以轻松恢复到文件的早期版本。
Web 编辑器会在后台执行 Git 操作。理解 Git 之后，你可以更高效地使用 Web 编辑器，并与在本地开发环境中工作的团队成员协作。
Git 为管理文档提供了一些关键功能。
- 版本历史：查看每个文件的更改内容、更改时间以及更改原因。
- 协作：多人可以同时在不同部分进行编辑。
- 安全性：可以放心尝试，而不会破坏线上文档。
- 审查流程：团队成员可以在发布前审查更改。
- 恢复：撤销错误或恢复到之前的版本。
如果你完全不熟悉 Git 和版本控制，可以按下面的步骤开始入门。
先使用网页编辑器。
网页编辑器 会自动处理 Git 操作。
- 在编写时即可直观看到所有更改。
- 一键创建分支。
- 在不使用 Git 命令的情况下发布并创建拉取请求 (PR) 。
这样你就可以在不使用命令行的前提下学习 Git 概念。
在实践中学习。
当你使用网页编辑器时，其实已经在使用 Git。
- 保存更改 会创建一次提交。
- Create branch 会创建一个 Git 分支。
- Publish 会发起一个供审查的拉取请求 (PR) 。
在需要时探索本地开发。
你可以完全通过网页编辑器和控制台管理文档，但也可以在本地环境中工作，自定义你的工作流。
- 在你喜欢的编辑器中创建和编辑文件。
- 使用命令行 Git、GitHub Desktop，或编辑器中的扩展。
- 在发布前在本地预览更改。
- 与其他工具集成，例如支持工单、问题跟踪和设计系统。
Web 编辑器通过 GitHub 应用、GitLab 集成 或 Bitbucket Cloud 集成 连接到你的 Git 存储库，并自动化常见的 Git 操作。
当你：
- 打开文件：编辑器会从你的存储库获取最新版本，确保你始终在处理最新内容。
- 进行更改：编辑器会跟踪你的更改，并在你保存工作时将其转换为一次提交。
- 保存更改：编辑器会基于你的更改创建一次提交，将你的工作保存在项目历史中。
- 创建 branch：编辑器会在你的存储库中创建一个新的 branch，任何具有存储库访问权限的人都可以使用它来协作并审阅更改。
- 在你的部署用分支上发布：编辑器会直接向你的部署用分支提交并推送，从而立即发布你的更改。
- 在其他分支上发布：编辑器会创建一个拉取请求 (PR；亦称“合并请求”/Merge Request) ，以便你在将更改合并到部署用分支之前先获取他人的反馈。
- 在网页编辑器中打开文件。
- 进行修改。
- 点击 Publish。
- 修改会同步到存储库并自动部署。
- 拉取最新变更：
git pull - 在你的编辑器中编辑文件。
- 暂存变更：
git add filename.mdx - 提交：
git commit -m "Update documentation" - 推送：
git push - 变更会自动部署。
创建一个 branch，在其上进行并保存更改，然后通过拉取请求将该 branch 合并到部署用分支。有关在网页编辑器和命令行中的分步说明，请参阅使用分支。要了解可用的发布操作如何随 branch 保护规则而变化，请参阅发布你的更改。
创建一个 feature branch。
在一个独立于部署用分支的 branch 中进行更改，这样你就可以在发布前共享并审查这些更改。
进行你的更改。
编辑文件并将更改提交到 feature branch。
创建一个 pull request。
创建一个拉取请求 (PR；亦称“合并请求”/Merge Request) ，以提议将 feature branch 上的更改合并到部署用分支。
审查 diff。
检查你的更改。拉取请求会逐行显示与文件原始版本之间的差异。
获取团队反馈。
团队成员可以针对特定行或整体更改发表评论。根据反馈进行修改，并将其提交到 feature branch。
批准后合并。
合并拉取请求，将更改发布到在线文档站点。
每个团队都会形成自己的工作流和偏好，但下面这些是帮助你入门的一般最佳实践。
- 编写有描述性的提交信息：使用主动语态，具体说明更改内容。
Fix broken link in API docs比update page提供更多信息。 - 使用有意义的 branch 名称：branch 名称应说明该 branch 的用途。使用类似
update-api-reference这样信息量大的名称，而不是temp或my-branch这类泛泛的名字。 - 让 branch 变更保持聚焦：让一个 branch 上的更改专注于某个特定任务或项目。这会让代码审查更容易，并减少冲突。
- 合并后删除 branch：在不再需要时删除 branch，以保持存储库整洁。
- 先 pull 再 push：始终在 push 之前先 pull 最新更改，以避免冲突。Web 编辑器会自动执行这一步。
- 先自查再发起审查：在创建拉取请求 (PR；亦称“合并请求”/Merge Request) 之前先检查 diff。