弃用文档

随着 Fuchsia 的发展，需要弃用已弃用的文档 文档过旧。

制定弃用时间表

在移除文档之前，请务必确定废弃 并通知用户一般来说，建议您移除相关文档 弃用期为 6 个月后。

要开始弃用流程并通知用户，请执行以下操作：

• 在 Markdown 文件中弃用某个文档
• 弃用导航栏中的文档

在 Markdown 文件中弃用某个文档

如需在 Markdown 文件中将文档标记为已弃用，请执行以下操作：

1. 找到前缀为 # 的网页标题。例如：

   # Deprecating documentation
   

2. 在文档标题下方添加以下 include 语句。例如：

   # Deprecating documentation
   
   {% include "fuchsia-src/_common/_deprecation_notice.md" %}
   
   

3. 向用户提供与弃用相关的信息，例如 弃用的原因。此外，还要添加任何新工具或功能 （而非已弃用的功能）

4. 在导航栏中将文档标记为已弃用。

弃用导航栏中的文档

如需在 _toc.yaml 文件中将文档标记为已弃用，请执行以下操作：

1. 找到 _toc.yaml 文件，该文件引用了您 正在弃用。例如：

   - title: "Deprecating documentation"
     path: /docs/contribute/docs/deprecating-docs.md
   

2. 在页面标题下方添加 status: deprecated 键值对。例如：

   - title: "Deprecating documentation"
     status: deprecated
     path: /docs/contribute/docs/deprecating-docs.md
   

3. 将更改（文档和 TOC 弃用）提交到 Fuchsia 代码库。

将页面重定向到弃用通知

弃用时间表过后，请删除相应网页并重定向它们。

如需删除网页并重定向，请执行以下操作：

1. 搜索所有引用您要移除的网页的链接。例如：

   grep -r "/docs/contribute/docs/deprecating-docs.md" ~/fuchsia/docs/
   

   这里会列出 grep 命令中链接到该页面的所有文档。

2. 更新或移除文档中引用以下网页的所有链接：

3. 使用 git rm 移除要弃用的文档。例如：

   git rm docs/contribute/docs/deprecating-docs.md
   

4. 找到引用了文档的 _toc.yaml 文件并移除 弃用文档的条目。

5. 确保 doc-checker 通过。运行 fx format-code 以运行文档检查工具：

   fx format-code
   

   请解决 doc-checker 可能会提示的所有问题。

6. 在 [/docs/_common/_deprecate-docs.yaml][deprecate-docs] 文件中，为以下项目创建一个重定向： 将已弃用的页面添加到弃用通知页面中。 此外，还应添加注释，列出弃用日期和弃用日期。 例如：

   # May 13th, 2022
   # Deprecating documentation around deprecation
   - from: /docs/contribute/docs/deprecating-docs.md
     to: /docs/contribute/docs/deprecation-notice.md
   

7. 将更改提交到 Fuchsia 代码库。