儲存庫資訊
每個儲存庫皆可包含說明、概覽及類別,以協助使用者了解其用途與用法。新增清晰的儲存庫資訊,能確保他人更容易找到您的映像檔並有效使用它們。
您只能修改未封存(archived)的儲存庫資訊。若儲存庫已封存,您必須先將其解封存才能進行修改。詳細資訊請參閱解封存儲存庫。
儲存庫說明
當使用 docker search 指令或在 Docker Hub 搜尋時,說明內容會顯示在搜尋結果中。
請參考下列儲存庫說明的最佳實作建議。
- 總結用途。以簡潔具體的方式明確陳述映像檔的功能。若該映像檔專為特定應用程式、工具或平台設計,或是具有特殊的應用場景,請務必說明清楚。
- 突顯關鍵功能或優勢。簡要提及該映像檔的主要優勢或獨特功能,例如高效能、易用性、輕量化建置,或是與特定框架或作業系統的相容性。
- 包含相關關鍵字。使用使用者可能會搜尋的關鍵字(如技術堆疊、應用場景或環境)來提高能見度。
- 保持簡潔。說明內容最多可包含 100 個字元。目標為將說明控制在一到兩句話以內,以確保在搜尋結果中易於閱讀。使用者應能快速理解該映像檔的價值。
- 聚焦於目標受眾。考量您的目標受眾(開發者、系統管理員等),並直接針對他們的需求撰寫說明。
遵循這些實作建議,能讓說明更具吸引力且在搜尋結果中更有效,進而為您的儲存庫帶來更多相關流量。
新增或更新儲存庫說明
登入 Docker Hub。
選擇 我的 Hub > 儲存庫。
您的儲存庫列表將顯示。
選擇一個儲存庫。
儲存庫的 一般 頁面將顯示。
選擇說明欄位下方的鉛筆圖示。
輸入說明。
說明內容長度最多可達 100 個字元。
選擇 更新 (Update)。
儲存庫概覽
概覽會描述映像檔的功能及執行方式。當儲存庫中至少有一個映像檔時,它會顯示在儲存庫的公開檢視頁面中。若啟用自動化建置,概覽將在每次成功建置時,從原始碼儲存庫的 README.md 檔案同步。
請參考下列儲存庫概覽的最佳實作建議。
- 描述映像檔的內容、所提供的功能以及為什麼應該使用它。可以包含使用範例或專案背後的團隊介紹。
- 說明如何開始使用該映像檔執行容器。您可以包含如何在 Dockerfile 中使用該映像檔的精簡範例。
- 列出主要的映像檔變體及標籤用法,以及這些變體的適用場景。
- 提供文件、支援網站、社群或郵件列表的連結,以獲取更多資源。
- 提供映像檔維護者的聯絡資訊。
- 包含映像檔的授權資訊,以及在需要時可查閱更多細節的連結。
新增或更新儲存庫概覽
登入 Docker Hub。
選擇 我的 Hub > 儲存庫。
您的儲存庫列表將顯示。
選擇一個儲存庫。
儲存庫的 一般 頁面將顯示。
在儲存庫概覽 (Repository overview) 下,選擇 編輯 (Edit) 或 新增概覽 (Add overview)。
系統會出現 撰寫 (Write) 和 預覽 (Preview) 分頁。
在 撰寫 (Write) 分頁下,輸入您的儲存庫概覽。
您可以使用基本的 Markdown 語法,並利用 預覽 (Preview) 分頁來預覽格式效果。
選擇 更新 (Update)。
儲存庫類別
您可以為 Docker Hub 儲存庫加上類別標籤,代表該映像檔的主要預期應用場景。這讓使用者能更輕鬆地探索他們感興趣的問題領域的內容。
可用類別
Docker Hub 內容團隊維護一份精選的類別清單。
類別包括:
- API 管理 (API Management):用於建立、發佈、分析及保護 API 的工具。
- 內容管理系統 (Content Management System):透過範本、程序及標準格式來建立與管理數位內容的軟體應用程式。
- 資料科學 (Data Science):支援分析資料並產生可執行見解的工具與軟體。
- 資料庫與儲存 (Databases & Storage):用於儲存、檢索與管理資料的系統。
- 程式語言與框架 (Languages & Frameworks):程式語言執行時期環境與框架。
- 整合與交付 (Integrations & Delivery):用於持續整合 (CI) 與持續交付 (CD) 的工具。
- 物聯網 (Internet of Things):支援物聯網 (IoT) 應用程式的工具。
- 機器學習與 AI (Machine Learning & AI):針對人工智慧與機器學習專案進行最佳化的工具與框架,例如預先安裝用於資料分析、模型訓練及部署的函式庫與框架。
- 訊息佇列 (Message Queues):為可靠、可擴展且高效的訊息處理所最佳化的訊息佇列系統。
- 監控與可觀測性 (Monitoring & Observability):透過指標、日誌與追蹤來追蹤軟體與系統效能的工具,以及用於探索系統狀態與診斷問題的可觀測性工具。
- 網路 (Networking):支援資料交換並連接電腦與其他裝置以共享資源的儲存庫。
- 作業系統 (Operating Systems):管理電腦上所有其他程式,並擔任使用者與電腦硬體之間中介的軟體,同時負責監督應用程式與系統資源。
- 安全 (Security):保護電腦系統或網路免受盜竊、未經授權存取,或硬體、軟體、電子資料損壞及服務中斷的工具。
- 網頁伺服器 (Web Servers):向使用者或其他系統提供網頁、HTML 檔案及其他資源的軟體。
- 網站分析 (Web Analytics):用於收集、衡量、分析及報告網頁資料與網站訪客互動情形的工具。
自動生成的類別
注意自動生成的類別僅適用於 Docker Verified Publishers 和參加 Docker 贊助之開源專案 (Docker-Sponsored Open Source) 的參與者。
對於在 Docker Hub 類別功能推出前就已存在的儲存庫,系統已使用 OpenAI 根據儲存庫標題與說明自動生成並套用了類別。
身為已被自動分類的儲存庫所有者,若您認為分類不準確,可以手動編輯這些類別。請參閱管理儲存庫的類別。
自動生成的分類是一次性的努力,旨在協助為此功能存在之前建立的儲存庫提供初始類別。新建立的儲存庫不會自動分配類別。
管理儲存庫的類別
您最多可以為一個儲存庫標記三個類別。
若要編輯儲存庫的類別:
登入 Docker Hub。
選擇 我的 Hub > 儲存庫。
您的儲存庫列表將顯示。
選擇一個儲存庫。
儲存庫的 一般 頁面將顯示。
選擇說明欄位下方的鉛筆圖示。
選擇您想要套用的類別。
選擇 更新 (Update)。
如果您需要的類別不在清單中,請使用意見回饋連結,讓我們知道您希望新增哪些類別。