影片

目錄

影片指南

Docker 文件中很少使用影片。使用時，影片應作為書面文字的補充，而不是唯一的文件形式。影片的製作時間可能比書面文字甚至螢幕截圖更長，維護也更困難，因此在新增影片之前請考慮以下幾點：

  • 您能證明客戶對使用影片有明確的需求嗎？
  • 影片是否提供了新的內容，而不是直接閱讀或重新利用官方文件？
  • 如果影片包含可能定期更改的使用者介面，您是否有維護計劃來保持影片的時效性？
  • 影片的語氣和語調是否與文件的其他部分一致？
  • 您是否考慮過其他選項，例如螢幕截圖或對現有文件進行說明？
  • 影片的質量是否與 Docker 文件的其餘部分相似？
  • 影片是否可以從網站連結或嵌入？

如果滿足以上所有條件，您可以在建立影片並將其新增到 Docker 文件之前參考以下最佳實踐。

最佳實踐

  • 確定影片的目標受眾。影片是面向初學者的廣泛概述，還是針對高階使用者的技術流程的深入講解？
  • 影片長度應少於 5 分鐘。請記住正確解釋主題所需的影片長度，如果影片需要超過 5 分鐘，請考慮使用文字、圖表或螢幕截圖代替。這些更容易讓使用者快速掃描相關資訊。
  • 影片應遵守與文件其餘部分相同的無障礙標準。
  • 透過撰寫指令碼（如果包含旁白）、確保多個瀏覽器和 URL 不可見、模糊或裁剪掉任何敏感資訊以及在不同瀏覽器或螢幕之間使用平滑過渡，來確保影片質量。

影片不託管在 Docker 文件庫中。要新增影片，您可以使用指向託管內容的連結，或者使用 iframe 進行嵌入。

iframe

要在文件頁面上嵌入影片，請使用 <iframe> 元素

<iframe
  class="border-0 w-full aspect-video mb-8"
  allow="fullscreen"
  title=""
  src=""
  ></iframe>

asciinema

asciinema 是一個用於錄製終端會話的命令列工具。錄製內容可以嵌入到文件網站中。它們類似於 console 程式碼塊，但由於是可播放和可拖動進度的影片，在某些情況下比靜態程式碼塊更有用。asciinema “影片”中的文字也可以複製，這使其更加實用。

如果出現以下情況，請考慮使用 asciinema 錄製：

  • 終端命令的輸入/輸出對於靜態示例來說太長（您也可以考慮截斷輸出）
  • 您想展示的步驟可以輕鬆地通過幾個命令演示
  • 在檢視命令的輸入和輸出都很方便的情況下

建立 asciinema 錄製並將其新增到文件中

  1. 安裝 asciinema CLI
  2. 執行 asciinema auth 來配置您的客戶端並建立帳戶
  3. 使用 asciinema rec 開始新的錄製
  4. 執行演示命令，然後使用 <C-d> 或 exit 停止錄製
  5. 將錄製內容上傳到 <asciinema.org>
  6. 使用 <asciinema.org> 上的“分享”按鈕，透過 <script> 標籤嵌入播放器
頁面選項