跳转到: 导航, 搜索

Blueprint-os-modularize-admin-docs

  • Launchpad 条目:
  • 创建者: Nicholas Chase
  • 贡献者:

总结

开发一个系统,通过包含构成各个指南的内容来创建整体的管理员指南。

这将能够创建一个全面的管理员指南,同时仍然能够为那些对全局视图感到不知所措或只是想查找单个主题的信息的人们创建较小的指南。

原理

目前,人们担心计算管理员指南“全面到几乎无用”。另一方面,手册太多,用户有时仅仅为了弄清楚去哪里查找信息就感到不知所措。这个项目的目的是创建一个框架,我们可以拥有一个全面的书籍,但仍然能够从相同的信息中创建较小的书籍。

设计

该系统

  1. 创建整体的管理员指南
  2. 创建任何尚未被其自身指南覆盖的较小管理员指南
  3. 依赖于一个包含所有内容的单个 Docbook 文件
  4. 需要在 generate-sources 中额外的 maven 目标来创建任何额外的必要指南

问题

  • 一些书籍(例如计算)需要重写,如果现在包含它们,Docbook 之后需要重新处理。
  • 一些书籍是用前言和附录编写的,因此不能直接包含它们的章节。相反,我们需要通过 XSLT 或 XPointer 提取章节的内容
  • 我们需要确定哪些书籍需要通过此过程生成,哪些书籍可以独立存在。