Github是如何使用Github来处理Github文档的

2015-1-12 16:56| 发布者: joejoe0332| 查看: 1810| 评论: 0|原作者: hy86, Windows10|来自: oschina

摘要: 提供书写良好的文档，可以帮助人们理解并很好地使用你的项目，而且人们还能够很容易地参与你的项目并作出贡献，但这仍不够。基于文档服务的底层系统能够使任何人——包括你或你的团队写文档更轻松。以前我们也谈论 ...

测试我们的站点

并不是因为站点是静态的我们就可以避免开发测试驱动。

我们第一个测试内容工具一直是 html-proofer。这个工具通过快速得检验我们站点上的每个URL帮助我们核实我们的链接和图片是否正常。

Ruby使用者更加熟悉使用Capybara在他们的测试中模拟网站互动。在我们的静态站点中实现一个类似的工具，这个想法疯狂吗？不！我们的工程师@bkeepers 四年前写了一篇博客讨论了这个问题。这样，我们有能力进行一次更强有力的测试，这测试涵盖我们的内容已和网站行为。比如，我们通过检查YAML文件中的键是否存在确认某个内容是否有效，或者我们会检测javascript代码是否运行良好。

我们的帮助文档运行在CI上以确保用户不会拿到损坏的内容：

速度快

如上所述，比起原来的Rails应用，我们的新Pages实现在速度上有极大的提升。部分原因在于，网站内容主要是大量的静态HTML文件——无需访问数据库。但最重要的是, 我们花费了大量时间来优化Pages服务器使得访问速度狂飙。另外，包括提供CDN这样的服务条件，我们也能一一满足。

让Github Pages为你工作

　　Github上的文档团队可以利用Github工作流，Jekyll 2.0和Github Pages来创建高质量的文档。Github Pages 提供给我们的文档团队的好处同样适用于任何使用Github Pages的用户。

　　随着我们将文档迁移到Pages，我们再也不需要重建任何新的组件。我们花了很少时间创建一些东西并花了很多时间讨论怎样的工作流对我们团队和公司才有意义。通过使用和广大Github用户一样托管系统，我们能提供更好更快的文档系统。我们内部的工作流使我们的工作效率显著提高，并且提供一些我们以前从未提供过的功能比如说版本化的文档。

　　如果你对我们的流程有任何疑问，无论何时，我们都很乐意帮助大家。

12 / 2 页在本页阅读全文