openSUSE:文档贡献
如何贡献
所有 openSUSE 手册都托管在 GitHub 上的 SUSE/doc-sle 仓库中。该仓库托管 SUSE Linux Enterprise Server/Desktop 和 openSUSE Leap 的文档。两种产品的手册都从同一个源生成,使用条件文本元素来区分特定于单个产品的部分。
openSUSE Leap 的发布版本发布在 https://doc.opensuse.net.cn/ 上。
报告文档错误或建议调整
在 https://doc.opensuse.net.cn/ 上发布的所有 HTML 版本在每个图注的右侧都包含一个报告错误链接。要报告手册相应部分的错误,请单击报告错误链接,在 http://bugzilla.opensuse.org/ 上打开一个预填充的错误报告模板。调整错误的标题并报告问题。
提交错误报告需要 openSUSE 登录。不接受匿名错误报告,因为如果出现问题,无法联系到匿名报告者。
通过 GitHub 贡献
如果您熟悉 GitHub,您可以评论编辑或 fork SUSE/doc-sle 以向我们发送拉取请求。有关更多信息,请参阅 README。
工具和技术
我们的手册是用 DocBook 5 编写的。与普遍认为的不同,DocBook 非常容易学习。如果您的编辑器正确支持 DocBook 编辑,那么编写 DocBook 甚至更容易。已知支持 DocBook 的开源编辑器包括
- emacs(使用内置的 NXML 模式加上 宏)
- jEdit
- vi(有关详细信息,请参阅 使用 Vim 编辑 XML/DocBook 文件)
为了以各种格式从 XML 源构建手册,我们使用 DAPS - DocBook Authoring and Publishing Suite 和 suse-xsl-stylesheets。这些软件包(daps、suse-xsl-stylesheets)在 openSUSE 上可用。这两个软件包的最新版本可在 Documentation:Tools 仓库 中获得。
如果您计划定期为我们的文档贡献力量,那么查看我们的 文档风格指南 可能会有所帮助。
联系 SUSE 文档团队
联系我们非常容易:发送邮件至 doc-team@suse.de,订阅 opensuse-doc 邮件列表 或加入 freenode 上的 #opensuse-doc IRC 频道。