发布任务详情¶

本节提供每个发布任务的详细说明。

安装指南测试¶

针对发布系列的安装指南测试由每个项目团队的成员或独立的文档贡献者处理。

在测试项目的安装文档时，重要的是结合其他相关项目，使用它们项目特定的安装文档进行测试。最好按照通用 OpenStack 安装指南中的说明进行操作。

请记住，所有项目安装文档都必须基于通用的 OpenStack 安装指南，并且必须链接回该指南。

当前正在开发的发布系列的全部项目安装指南列表，请参见 https://docs.openstack.org/2025.2/install/。

为了方便起见，提供了一个安装指南审核收件箱。收件箱概述了当前开放的更改，这些更改涉及项目团队仓库中 `doc/source/install/` 下的文件。

一旦预发布软件包可用，您就可以开始测试。测试人员应查看文档的当前最新版本，并尝试在预发布软件包上运行每个命令。如果无法运行命令，并且确认是文档中的错误，请在 Launchpad 中针对相应的项目提交错误报告。

发行说明¶

OpenStack 手册不再处理项目团队的发布说明。但是，我们需要为我们的文档编写发布说明。发布说明应在发布过程中发生重大更改时添加，但是作者和审核员经常会忽略这一点，因此需要进行最终审核以检查所有重大更改是否已包含在内。

请联系每个子团队负责人，名单见文档团队结构，并询问他们所负责文档的说明。

发布说明的来源是 `openstack-manuals/releasenotes/source/RELEASENAME.rst`，并发布到 `https://docs.openstack.org/releasenotes/openstack-manuals/RELEASENAME.html`。

更新发布结束时的 www 页面¶

在 openstack-manuals 仓库中进行以下更改

将“latest”项目数据文件复制到命名为正在完成的发布版本的文件
```
$ cp www/project-data/latest.yaml www/project-data/RELEASE.yaml
```
通过将现有模板复制到新目录，为新发布创建 docs.openstack.org 页面
```
$ cp -a www/RELEASE www/NEXT_SERIES
```

更新模板生成器（`tools/www-generator.py`）源文件顶部的 `SERIES_INFO` 数据结构。有关结构的详细信息，请参见模板生成器详情。

将状态为 `development` 的系列更改为状态 `maintained`。
添加一个新条目，用于新系列，给出预计的发布日期并将状态设置为 `development`。

例如，在 Pike 周期结束时，变量将包含

SERIES_INFO = {
    'austin': SeriesInfo(date='October 2010', status='obsolete'),
    # ...
    'mitaka': SeriesInfo(date='April 2016', status='EOL'),
    'newton': SeriesInfo(date='October 2016', status='maintained'),
    'ocata': SeriesInfo(date='February 2017', status='maintained'),
    'pike': SeriesInfo(date='August 2017', status='development'),
}

要更新设置

pike 的状态更改为 `maintained`
添加了一个 queens 的新条目

SERIES_INFO = {
    'austin': SeriesInfo(date='October 2010', status='obsolete'),
    # ...
    'mitaka': SeriesInfo(date='April 2016', status='EOL'),
    'newton': SeriesInfo(date='October 2016', status='maintained'),
    'ocata': SeriesInfo(date='February 2017', status='maintained'),
    'pike': SeriesInfo(date='August 2017', status='maintained'),
    'queens': SeriesInfo(date='August 2017', status='development'),
}

这将导致 docs.openstack.org 重定向到当前版本的特定系列登录页面，并且正在完成的版本的模板将使用上一步创建的文件中的数据。

使用 `tox -e publishdocs` 在本地测试构建。

如果缺少任何项目链接并导致模板生成器失败，请设置标志以禁用链接到这些文档。例如，如果“foo”没有配置参考指南，请通过修改步骤 1 中创建的文件，将 `has_config_ref: false` 设置为“foo”项目。

注意

如果任何链接标志设置为 false 或任何项目被注释掉，则有人需要定期检查这些文档，以便在受影响的项目中创建新分支时发布这些文档。应在最终发布截止日期之前创建所有分支，因此应该可以更新项目数据设置，以便该站点链接到所有最新的文档。

警告

当进行这些更改的补丁合并时，docs.openstack.org 将立即更新以重定向到发布版本。以前的发布页面仍然存在于其旧位置。

注意

文档站点的更改可能需要一个小时或更长时间才能填充，具体取决于网关的状态以及发布时推送的更改数量，因此请准备好提前准备好发布当天的补丁，以便在官方发布时间之前使用。您可以在 Zuul 状态处检查当前的网关状态，以了解当前的合并时间。

生成站点地图¶

在发布当天的补丁合并后，使用 openstack-doc-tools 仓库中的 `sitemap` 脚本为 docs.openstack.org 生成新的站点地图。将 `sitemap.xml` 文件复制到 openstack-manuals 仓库中的 `www/static` 目录中，并提交更改。

生命周期结束¶

一旦发布版本达到生命周期结束，您必须停止生成新的出版物。为了指示生命周期结束，请在特定于发布版本的文档的索引处添加以下句子

.. warning::

   This guide documents the OpenStack Liberty release and is frozen
   as OpenStack Liberty has reached its official end-of-life.
   This guide will not get any updates from the OpenStack project anymore.
   See the `OpenStack Documentation page
   <https://docs.openstack.org/>`_ for current documentation.

对于持续发布的文档，从目标中排除该版本。

例如，从

This guide documents OpenStack Newton, Mitaka, and Liberty releases.

到

This guide documents OpenStack Newton and Mitaka releases.

参见

有关构建生命周期结束版本的文档的说明，请参见构建生命周期结束版本的文档。

发布任务详情

发布任务详情¶

安装指南测试¶

发行说明¶

更新发布结束时的 www 页面¶

生成站点地图¶

生命周期结束¶

文档贡献者指南

页面内容