以下部分概述了为 Linux 文档项目创建和/或维护文档的流程。本节包括所有步骤——其中一些步骤可能与您的特定文档无关。
加入 discuss 邮件列表。有兴趣接管他人文档维护工作的作者也应加入此列表。这是为了确保 LDP 知道谁在负责哪些文档。
如果您尚未编写文档,请查看我们的文档(当前、未维护 和 进行中)并向列表提交提案。您的提案应包括您的文档与已在集合中的文档有何不同的原因;或确定当前我们的文档中缺少的主题。有关编写提案的更多信息,请阅读第 3 章。
有关邮件列表的更多信息,请阅读第 2.2 节或访问lists.tldp.org进行订阅。如果您的文档已经编写完成,请将副本提交到 discuss 列表(或包含可以找到它的 URL)。
编写您的文档。如果您的文档尚未编写完成,请务必在开始编写之前发送电子邮件至 discuss 列表。您可以选择您感觉最舒适的任何格式来编写文档。 如果它不是 LDP 接受的格式之一,将会有志愿者为您转换格式。有关编写技术文档的更多信息,请阅读第 4 章。
如果您要添加自己的标记,您可能还需要加入 docbook 邮件列表。有关 LDP DocBook 列表的更多信息,请阅读第 2.2 节。如果您想从模板开始,您可能会发现附录 A 中的模板很有用。第 5 章中也有一般标记介绍,附录 D 中有大量示例。
提交您的文档以进行技术、语言和元数据审查。通过将您的文档通过电子邮件发送至<submit@en.tldp.org>来完成此操作。在主题行中,请务必提供文档的标题。在电子邮件正文中,说明您已准备好进行审查流程。概述您的文档可能已经收到的任何其他审查。您应该在一周内被分配一名审查员。审查可能还需要额外一周的时间。有关此流程的更多信息,请阅读第 6 章。
如果您的文档尚未采用 DocBook 或 LinuxDoc 格式,审查员将为您转换格式。
一旦您的文档通过了每个审查,审查协调员将把它添加到 CVS,将版本号更新为 1.0,并在公共网站上发布该文档。有关您最终提交给 LDP 的更多信息,请阅读第 6.5 节。
![]() | 如果您未以 DocBook 格式提交文档 |
---|---|
为您的文档添加标记的志愿者可以选择任何接受的标记语言。但是,《作者指南》将仅参考 DocBook。如果您提交的是纯文本或其他格式,如果您希望以 LinuxDoc 或 DocBook(最终结果的接受格式)维护您的文档,请告知 LDP。 |