带源代码管理的Wiki文档站点&发布管理

时间:2016-09-12 12:20:39

标签: tfs version-control wiki release-management

我一直在寻找有关可用wiki软件的信息,使用https://en.wikipedia.org/wiki/Comparison_of_wiki_software之类的网页,我正在寻找能够满足一系列要求的解决方案,但还未能找到任何合适的解决方案。 。我希望以类似于TechNet,MSDN或https://documentation.red-gate.com的形式创建文档站点,虽然这可以使用SharePoint站点或传统维基(如MediaWiki)完成,但这些通常用于开放,社区编辑内容迅速发展,或内部公司文档,其中存在错误和不完整的内容不被视为问题。在这种情况下,文档将在线显示给客户,并且只能由我们的员工编辑,因此最好将其内容置于源代码控制中并使用托管版本到不同的环境(即我们的员工编辑的DEV站点)内容,一个用于校对的TEST站点和一个LIVE站点,在线供公众使用,因此半写内容或未经过校对读取的内容不会立即显示在标准wiki中,而是能够允许员工以维基格式快速编辑文档也很重要。

我知道Sandcastle,Document这样的项目! X和Doxygen,它直接从源代码生成MSDN样式文档,但不打算将其作为源代码注释生成的文档站点,而是包含书面文章的文档站点。从本质上讲,我正在寻找提供以下功能的软件:

  • 维基的易用性 - 任何人都可以登录DEV网站并添加/编辑内容。
  • 所有内容的源代码控制,可能是Markdown文件和图像,而不是在数据库中,源控件(TFS)自动更新/文件签出/签入,通过上述“简单编辑”维基功能。 / LI>
  • 由于上述原因,您可以将文档“发布”到测试和生产环境,就像使用任何其他网站解决方案一样。

其他示例包括http://uk.mathworks.com/helphttps://docs.python.org/3/tutorial/introduction.html等网站。任何人都可以提供有关此类解决方案是否可用的信息,或者解释如何管理MSDN,TechNet或RedGate文档站点等站点以及用于它们的应用程序?

1 个答案:

答案 0 :(得分:1)

在Redgate,我们使用Atlassian Confluence。它已经存在了一段时间,尽管有一些怪癖,我强烈建议你自己尝试一下。它可以托管或内部部署,并且具有丰富的扩展和其他自定义选项。