跳转到: 导航, 搜索

文档贡献者指南

关于文档贡献者指南团队

考虑到贡献者的经验和反馈,我们愿意改进和重构 Documentation/Conventions 页面,以便创建一个完整且整洁的指南,解答文档创建流程中出现的问题。

快速链接

维护

  • 在提交信息的主题行中使用 [贡献者指南]
  • 提交新的补丁时,始终在提交信息中添加 'Implements: blueprint docs-contributor-guide'。 这样,补丁的链接将自动添加到蓝图中。

从 Wiki 迁移和重构内容

在下表中注册一个章节,然后创建 openstack-manuals/doc/contributor-guide/source/ 中的 RST 格式补丁供其他人审查。

在您当前处理的页面上添加关于 Wiki 页面内容迁移状态的注释,以便如果 Wiki 内容发生更改,相同的更改也会应用到 RST 文件中。

Wiki 页面 链接 负责人 Gerrit 链接 状态
如何操作 https://wiki.openstack.org/wiki/Documentation/HowTo Olena Logvinova Maria Zlatkova https://review.openstack.org/#/c/237089/ https://review.openstack.org/#/c/234320/ https://review.openstack.org/#/c/235488/1 https://review.openstack.org/#/c/233183/ https://review.openstack.org/#/c/234279/1 https://review.openstack.org/#/c/237534/ https://review.openstack.org/#/c/238483/ 已合并
HowTo/FirstTimers https://wiki.openstack.org/wiki/Documentation/HowTo/FirstTimers Olga Gusarenko https://review.openstack.org/#/c/227191/ 已合并
文档/Builds https://wiki.openstack.org/wiki/Documentation/Builds Olena Logvinova https://review.openstack.org/#/c/225651/ 已合并
文档/ContentSpecs https://wiki.openstack.org/wiki/Documentation/ContentSpecs Maria Zlatkova https://review.openstack.org/#/c/225110/ 已合并
Documentation/Conventions https://wiki.openstack.org/wiki/Documentation/Conventions Svetlana Karslioglu https://review.openstack.org/#/c/220389/ 已合并
Documentation/Markup_Conventions https://wiki.openstack.org/wiki/Documentation/Markup_conventions Olga Gusarenko:RST 格式和 DockBook 规范 https://review.openstack.org/#/c/215660/ https://review.openstack.org/#/c/218799/ https://review.openstack.org/#/c/232966/ https://review.openstack.org/#/c/238438 已合并
Documentation/JSON_Conventions https://wiki.openstack.org/wiki/Documentation/JSON_conventions Olena Logvinova https://review.openstack.org/#/c/228359 已合并
文档/Structure https://wiki.openstack.org/wiki/Documentation/Structure Olga Gusarenko https://review.openstack.org/#/c/220494 已合并

添加新内容

主题标题 评论 负责人 Gerrit 链接 状态
许可和版权 包含指向 https://openstack.org/brand/https://review.openstack.org/static/cla.htmlhttps://wiki.openstack.org/wiki/How_To_Contribute#Contributors_License_Agreement 的链接的概要
截图和拓扑约定
团队结构 https://wiki.openstack.org/wiki/Documentation/SpecialityTeams Olena Logvinova https://review.openstack.org/#/c/267481 已合并

Meetings

  • 时间:每周四 14:00 UTC(澳大利亚东部标准时间周五上午 12:00 或 GMT+10,太平洋标准时间周三上午 7:00)
  • 地点:Google Hangouts
  • 参与方式:联系 Olga GusarenkoMaria ZlatkovaOlena Logvinova