OpenStack 文档贡献者指南

摘要

本指南为所有文档贡献者提供了详细的贡献流程和规范说明。请遵循这些指南，以保持文档结构、风格和语法的统一性。

目录

• 快速入门
  • 首次贡献者
  • 开发者
• 文档团队结构
• 2017/2018 文档团队愿景
  • 目标
  • 背景
  • 用例
  • 设定期望
  • 内容可见性
  • 贡献文档
• 非母语英语使用者
  • 英语为第二语言的新贡献者
  • 与非母语英语使用者合作
• 蓝图和规范
• 项目指南设置
  • 安装指南
  • 部署指南
• docs.openstack.org 上的登陆页面
• 治理标签文档指南
  • 定义
  • 指南
• OpenStack API 文档
  • developer.openstack.org 的源文件
  • OpenStack 中 API 参考的标准
  • API 参考信息的版本和发布
  • 如何记录您的 OpenStack API 服务
• 文档错误
  • DocImpact
  • 提交错误报告
  • 处理文档错误
  • 处理文档故事
  • 对 openstack-manuals 进行错误分类
  • 第三方驱动程序的错误
• 编写文档
  • 主题结构
  • 主题标签
  • 额外的 Git 工作流程
• 写作风格
  • 通用写作指南
  • 词语选择
  • 标点符号
  • 标题
  • 列表
  • URL
  • 数字和计量单位
  • OpenStack 服务和项目名称
  • 发布名称
  • 标准 UI 术语
  • 代码规范
• OpenStack 用户体验和用户界面指南
  • OpenStack 人物
  • GUI 指南
  • UI 文本指南
• RST 规范
  • 通用指南
  • 文件命名和结构
  • 标题
  • 行内元素
  • 列表
  • 特定信息块
  • 代码示例
  • 参考文献
  • 表格
  • 图形
  • 分析
  • 注释
  • 装饰
  • 有用的链接
• JSON 规范
• 图表指南
  • 谨慎使用图表
  • 工具
  • 使用推荐的文件格式
  • 通用指南
• 审查文档
  • 审查指南
  • 仓库和核心团队
  • 审查文档补丁
  • 获得核心审查员身份
  • 核心审查员职责
• 构建文档
  • 首先克隆一个仓库
  • 本地构建输出
  • 构建任务
  • 构建已停止支持发布的文档
• 重定向文档
  • 将 .htaccess 文件添加到您的仓库
  • 为您的项目启用详细的重定向
  • 测试您的重定向
  • 可选：从 Git 生成 .htaccess 文件
• 使用文档工具
  • 脚本概述
  • 模板生成器详情
  • 安装 OpenStack 文档工具
  • 贡献 OpenStack 文档工具
• 发布文档版本
  • 发布任务概述
  • 发布任务详情
  • 发布工具

词汇表

• 术语表

搜索

• 搜索页面