Help us learn about your current experience with the documentation. Take the survey.

弃用和移除

当 GitLab 弃用或移除某个功能时，请使用以下流程更新文档。 此流程需要先将内容临时更改为"已弃用"或"已移除"，然后再删除。

如果某个功能未普遍可用，您可以直接删除内容，无需遵循这些说明。

在以下情况下，适用单独的流程：

不再积极开发的功能

当某个功能不再积极开发，但未弃用时，请在主题标题和版本历史下添加以下注释：

{{< alert type="note" >}}

此功能未在积极开发中，但
欢迎[社区贡献](https://about.gitlab.com/community/contribute/)。

{{< /alert >}}

弃用页面或主题

要弃用页面或主题：

  1. 在标题后添加 (deprecated)。使用警告 alert 说明弃用时间、移除时间和替代功能。

    title: 标题 (deprecated)
---

{{< details >}}

- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< alert type="warning" >}}

此功能已在 GitLab 14.8 中[弃用](https://issue-link)，
计划在 15.4 中移除。请改用[功能 X](link-to-docs.md)。

{{< /alert >}}

    如果不确定功能何时移除或没有替代功能，则无需添加此信息。

  2. 如果弃用是破坏性变更，请添加以下文本：

    此变更是破坏性变更。

    您可以添加任何可能帮助用户的额外上下文特定详细信息。

  3. 在内容上方和下方添加以下 HTML 注释。对于 remove_date， 设置为移除功能的发布版本后三个月的日期。

    title: 标题 (deprecated)
---

<!--- start_remove 以下内容将在 remove_date: 'YYYY-MM-DD' 时移除 -->

{{< details >}}

- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< alert type="warning" >}}

此功能已在 GitLab 14.8 中[弃用](https://issue-link)，
计划在 15.4 中移除。请改用[功能 X](link-to-docs.md)。

{{< /alert >}}

<!--- end_remove -->

  4. 打开合并请求，在左侧导航中页面标题后添加 (deprecated)。

移除页面

在功能被移除的发布版本期间，将内容标记为已移除。 标题和移除指示器将保留到移除后三个月。

要移除页面：

  1. 保留页面标题。删除所有其他内容，包括历史记录项和 details 和 alert 短代码。

  2. 在 title 后，将 (deprecated) 更改为 (removed)。

  3. 更新 YAML 元数据：

    • 对于 remove_date，设置为功能被移除的发布版本后三个月的日期。
    • 对于 redirect_to，设置一个有意义的文件路径。如果没有明显的页面， 请使用文档首页。
    ---
stage: AI-powered
group: Global Search
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
remove_date: '2022-08-02'
redirect_to: '../newpath/to/file/_index.md'
title: 标题 (removed)
---

{{< details >}}

- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

此功能已在 GitLab X.Y 中[弃用](https://issue-link)，
并在 X.Y 中[移除](https://issue-link)。
请改用[功能 X](link-to-docs.md)。

  4. 编辑 docs-gitlab-com 中的 navigation.yaml， 从全局导航中移除该页面条目。

  5. 在弃用和移除页面中搜索 到移除页面的链接。链接使用完整 URL，如：https://docs.gitlab.com/user/deprecated_page/。 如果找到任何链接，请更新相关的YAML 文件：

    • 在 body: 部分，移除到移除页面的链接。

    • 在 documentation_url: 部分，如果条目链接到该页面，请删除链接。

    • 运行 Rake 任务更新文档：

      bin/rake gitlab:docs:compile_deprecations

此内容作为技术写作团队 定期任务的一部分从文档中移除。

移除主题

要移除主题：

  1. 保留标题和弃用及移除的详细信息。删除所有其他内容， 包括历史记录项和 details 和 alert 短代码。

  2. 在标题后添加 (removed)。

  3. 在主题上方和下方添加以下 HTML 注释。 对于 remove_date，设置为移除后三个月的日期。

    title: 标题 (removed)
----

<!--- start_remove 以下内容将在 remove_date: 'YYYY-MM-DD' 时移除 -->

{{< details >}}

- Tier: Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

此功能已在 GitLab X.Y 中[弃用](https://issue-link)，
并在 X.Y 中[移除](https://issue-link)。
请改用[功能 X](link-to-docs.md)。

<!--- end_remove -->

  4. 在弃用和移除页面中搜索 到移除页面的链接。链接使用完整 URL，如：https://docs.gitlab.com/user/deprecated_page/。 如果找到任何链接，请更新相关的YAML 文件：

    • 在 body: 部分，移除到移除页面的链接。

    • 在 documentation_url: 部分，如果条目链接到该页面，请删除链接。

    • 运行 Rake 任务更新文档：

      bin/rake gitlab:docs:compile_deprecations

此内容作为技术写作团队 定期任务的一部分从文档中移除。

移除特定版本的升级页面

特定版本的升级页面位于 doc/update/versions/ 目录中。

对于主要里程碑，我们不会立即移除特定版本的升级页面。这给用户 时间从旧版本升级。

例如，doc/update/versions/14_changes.md 应该 在 .3 里程碑期间移除。因此 14_changes.md 在 GitLab 17.3 中被移除。

与其移除不支持的页面：

如果 X_changes.md 页面包含指向其他部分的相对链接， 这些链接作为版本清理的一部分被移除，docs-lint links 作业可能会失败。您可以将这些相对链接替换为归档版本。 选择要移除的不支持版本的最新次要版本。