0

我需要你的指导...

鉴于一个组织可能在不同的存储库中拥有多个产品，并且可能有许多文档存储库，如何将所有内容集成到一个“docs.acme.com”站点中？

例如：3 个产品：X、Y 和 Z，并且 Z 有多个 repos。每个都有自己的 /docs。

产品X.git

  • /src/ sln + *.csproj
  • /文档/*

产品Y.git

  • /src/ sln + *.csproj
  • /文档/*

productZ.core.git

  • /src/ sln + core.csproj
  • /docs/* productz.wpf.git
  • /src/ sln + wpf.csproj
  • /docs/* productz.web.git
  • /src/ sln + wpf.csproj
  • /文档/*

一些团队甚至有一个概念文档仓库。

TeamFoo.git

  • /文档/*

和“父”回购

docs.acme.git

  • /文档/*

结果（如果我们模仿 docs.microsoft.com）：

  • docs.acme.com/
  • docs.acme.com/products/
  • docs.acme.com/products/productX/
  • docs.acme.com/products/productY/
  • docs.acme.com/products/productZ/
  • docs.acme.com/products/productZ/core/
  • docs.acme.com/products/productZ/wpf/
  • docs.acme.com/products/productZ/web/
  • docs.acme.com/teams/foo/
  • docs.acme.com/teams/bar/

这怎么可能 ？

如果每个 repo/docs 都有自己的 docfx.json，那么编译的每个 _site 都将被视为“父站点”，这是不正确的。

到目前为止，我最接近的是每个子文档都有一个存根 index.md 和 toc.yml 并复制“目标文件夹结构”，并有一个“父构建”，其中包括作为参考的子存储库和副本他们的相对文件夹。

它可以工作，但不是一个高效也不优雅的解决方案。

要求：

  • 作为“产品”开发人员，当我运行 docfx serve 时，我可以验证文档看起来不错。
  • 作为“企业文档”集成商，父文档和子文档工作/看起来是一体的。
  • 作为“贡献者”，当我点击“贡献给这个文档”时，我会找到正确的仓库/文件
4

0 回答 0