淘汰說明文件

隨著 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 存放區。