[ English | 한국어 (대한민국) | Indonesia | Deutsch | español (México) | English (United Kingdom) | 中文 (简体, 中国) ]

文档

本部分包含有助于OpenStack文档的信息。

项目仓库中的文档

所有项目文档都必须遵循相同的目录结构,该结构在 Project Guide Setup page 中进行了描述。

文档目录结构如下:

└── source
    ├── admin
    ├── cli
    ├── configuration
    ├── contributor
    ├── install
    ├── reference
    └── user

安装指南

安装指南可以在 install 目录中找到。 它包含关于从软件包安装项目的任何信息,例如,安装项目所需的软件,例如数据库安装和配置,或需要在项目的配置文件中设置哪些参数等等。 如果一切都配置正确(如下所述),则项目的安装指南包含在 OpenStack Installation Guides 中。 本安装指南不适用于生产系统安装。

贡献者指南

贡献者指南可在 contributor 目录中找到。 它包含有关项目贡献和团队管理的特定于项目的信息。 贡献者指南仅出现在项目的文档中。

配置参考

configuration 目录包含配置参考信息,这些信息可以自动生成(如果项目使用 oslo.config )或手动编写(如果不使用 oslo.config )。 有关更多信息,请参见 Sphinx Integration

CLI参考

cli 目录包含命令行工具参考文档,这些文档可以通过cliff的sphinx集成自动生成,或者在无法自动生成时手动编写。 有关更多信息,请参见 cliff Sphinx Integration

管理员指南

管理员指南可以在 admin 目录中找到。 它包含有关软件配置和操作的信息。 项目的管理员指南包含在 OpenStack Administrator Guides 中。

用户指南

user 目录包含针对最终用户的信息,例如概念指南,教程,使用CLI或项目API的分步说明等。

参考文档

reference 目录包含其他目录中未包含的参考信息,例如库项目中自动生成的类文档。

发布项目仓库中的文档

为了将项目文档链接到 OpenStack documentation portal 上,在 openstack-manuals 仓库中的 www/project-data/latest.yaml 文件必须遵循 template generator 的规则进行更新。

  1. 在文件中找到您的项目

  2. 将所有适用的文档选项设置为’true’。 例如:

    has_install_guide: true
    has_api_ref: true
    has_admin_guide: true
    has_config_ref: true
    has_user_guide: true
    

如果项目仓库中存在上述结构,并且 latest.yaml 文件已更新,则 project-config 仓库中的 publish-openstack-sphinx-docs 作业会自动将文档包含在已发布的文档。 有关详细说明,请参见 Project guide setup