[发明专利]一种自动化的多产品文档统一发布展示方法

说明书

本发明公开一种自动化的多产品文档统一发布展示方法，涉及文档管理技术领域，其实现包括Webhook监听服务与渲染管线服务两部分；Webhook监听服务以Web服务形式提供一个持续运行的API接口，来接收代码仓库推送的markdown文档源码更新事件，并根据接收的更新事件提取请求数据包内的参数，随后将数据包内记录的仓库信息和版本信息发送至渲染管线服务；渲染管线服务中预定义有流水管线，渲染管线服务接收文档更新任务，并将任务数据交给空闲的工作队列，工作队列启动预定义的流水管线依次渲染每个markdown文档，并生成对应的静态网页，最终自动发布更新到站点，用户访问站点链接即可查看最新生成的文档页面。本发明可以解决多产品文档统一管理发布以及版本控制的难题。

技术领域

本发明涉及文档管理技术领域，具体的说是一种自动化的多产品文档统一发布展示方法。

背景技术

对于企业而言，文档是重要的智力资产。

在IT企业中，一个良好的产品研发文档系统对于企业产品研发和交付效率的提升以及提升团队协作效率和节约沟通成本等各方面均有巨大的助益。一般情况下，多数技术团队采用源代码版本管理工具(如Git)等来管理研发技术类文档。Git是一个开源的分布式版本控制系统，可以有效、高速地处理从很小到非常大的项目版本管理。Git是LinusTorvalds为了帮助管理Linux内核开发而开发的一个开放源码的版本控制软件，与常用的版本控制工具CVS,Subversion等不同，它采用了分布式版本库的方式，不必服务器端软件支持。

然而，传统的代码管理工具以仓库为单位，每个文档需要建立独立的代码仓库管理，如设计文档、开发文档、部署文档等。当企业团队规模较大、产品线较丰富时，需要管理的文档仓库数量也成指数级增长。但传统的代码版本控制工具无法做到多文档的统一协同管理，也无法方便的对外展示和查阅。

发明内容

本发明针对目前技术发展的需求和不足之处，提供一种自动化的多产品文档统一发布展示方法，解决多产品文档统一发布展示以及版本控制的难题。

本发明的一种自动化的多产品文档统一发布展示方法，解决上述技术问题采用的技术方案如下：

一种自动化的多产品文档统一发布展示方法，其实现包括Webhook监听服务与渲染管线服务两部分；

Webhook监听服务以Web服务形式提供一个持续运行的API接口，来接收代码仓库推送的markdown文档源码更新事件，并根据接收的更新事件提取请求数据包内的参数，随后将数据包内记录的仓库信息和版本信息发送至渲染管线服务；

渲染管线服务中预定义有流水管线，渲染管线服务用于接收Webhook监听服务派送的文档更新任务，并将任务数据交给内部空闲的工作队列，工作队列接收到任务数据后，启动预定义的流水管线依次渲染每个markdown文档，并生成对应的静态网页，最终自动发布更新到站点，用户访问站点链接即可查看最新生成的文档页面。

进一步的，产品文档统一发布展示方法基于Git版本控制工具实现markdown文档内容的存储、编辑、协作和版本控制，并使用Gitlab进行Git仓库的集中存储托管，使用Gitlab提供的Webhook功能实现根据markdown文档源码变更自动更新站点内容。

进一步的，当用户修改了markdown文档或者发布了新版本的TAG并将变更推送到代码仓库中时,代码仓库根据Webhook监听服务提供的API接口接收代码仓库推送的markdown文档源码更新事件。

进一步的，工作队列的任务数据执行完成后，工作队列重新转入空闲状态，等待渲染管线服务派发下一次文档更新任务。

优选的，采用Hugo文档渲染工具进行渲染管线服务。

优选的，Hugo文档渲染工具使用Golang语言编写。