tl; dr:我们正在使用GitHub和Jekyll与Textile支持页面的组合来呈现内部文档集。效果很好,除了一件事:在提议的更改中读取差异真的很难。
更长的版本:
我们有一个GitHub仓库,其中包含一个Jekyll安装和包含我们文档内容的Textile代码。随着我们设计产品的新方面,本文档集经常发生变化。我们添加新文档的工作流程如下所示:
在第3步,我们通常会发现自己正在阅读GitHub拉取请求页面中的“已更改文件”标签。这是次优的,因为Textile代码通常超出GitHub界面的屏幕宽度,而diff屏幕通常只包含几行上下文。这通常不足以真正理解拟议的变更。
我希望看到的是什么:
当提交或更新提取请求时,Jenkins(或类似)作业运行并呈现PR的分支的内容,并标记添加和删除。 (想象一下< span class =“addition”>或< span class =“delete”>围绕修改。)
有人知道这是否已经完成?或者,如果我们独自一人,还有任何明智的实施技巧吗?
谢谢!