Pingcap/TiDB文档挑战赛 - 贡献翻译教程
1. GitHub & GitHub Desktop
GitHub
GitHub 是一个基于 web 的提供版本控制和托管服务的平台。大多数程序员都比较熟悉,上面有很多开源项目,可以参与进去,也可以自己创建或维护一个项目。
GitHub: https://github.com/
我的 GitHub 个人主页是:RobertCheng-956
GitHub是世界上最大的开源平台,如今世界上已经有了1亿用户。
GitHub Desktop
刚刚提到了Github是一个版本控制和托管服务的平台,如何进行版本控制,如何将本地的文件托管到GitHub上,这就涉及到了GitHub Desktop。GitHub Desktop是一个软件,在提交翻译文件的过程中需要使用,具体的流程和步骤,往后看。
2. 为什么使用GitHub进行文档写作
使用GitHub进行文档写作的优势
- 版本控制: GitHub基于Git,提供了强大的版本控制功能。这意味着你可以轻松地跟踪文档的修改历史,了解每个版本的变更,回溯到之前的版本,以及协同编辑文档而不用担心冲突。
- 分支和合并: 使用分支可以让不同的作者独立地编辑文档的不同部分,而不会影响到主分支。通过合并分支,可以将各自的修改整合到主文档中,有序地管理多个人的贡献。
- 协同编辑: GitHub支持多人同时编辑文档,而无需手动合并更改。每个人都可以创建自己的分支,进行编辑,然后通过Pull Request请求将其更改合并到主文档中,便于审查和讨论。
- 问题追踪: GitHub的问题追踪系统可以用于讨论文档中的问题、提出改进建议或报告错误。这种集成的讨论平台有助于组织协作者之间的反馈,促进文档的改进。
- Markdown支持: GitHub广泛支持Markdown格式,这使得编写简洁、易读的文档变得简单。Markdown的语法清晰,并且可以直接在GitHub上进行预览。
- 社区协作: GitHub是一个庞大的开发者社区,许多项目和团队都在这里分享文档。这意味着你可以从其他人的经验中学习,并向开源社区贡献自己的文档。
- 访问控制: GitHub提供了对仓库的访问控制,可以设置不同的权限级别,确保只有授权人员才能编辑或审查文档。
其中最主要的就是,协同编辑和版本控制,其中协同编辑,不仅仅指的是technical writer来进行编辑,文档的用户也可以通过提交自己的Pull Request来进行修改,同时用户也能够提Issue来反馈文档中存在的问题。
注册GitHub
前置要求:科学上网(虽然不使用科学上网也能够使用GitHub,但是访问速度会比较慢。)
3. Pingcap 翻译文档贡献指南
可以查看2024 TiDB 文档挑战赛通关秘籍|TiDB 文档小知识✨(持续更新!)
具体的流程详情请看上一篇文档 如何通过GitHub Desktop创建Pull Request? | Ray (robertcheng-956.github.io)
评论
评论插件加载失败
正在加载评论插件