仓库信息

Table of contents

每个仓库可以包含描述、概述和分类，以帮助用户理解其用途和使用方法。添加清晰的仓库信息可确保其他人能够找到您的镜像并有效地使用它们。

您只能修改未归档的仓库信息。如果仓库已归档，您必须先取消归档才能修改信息。有关详细信息，请参阅取消归档仓库。

仓库描述

在使用 docker search 命令和 Docker Hub 上的搜索结果中，描述会显示在搜索结果中。

请考虑以下仓库描述的最佳实践。

  • 总结目的。以简洁且具体的方式清楚地说明镜像的功能。如果镜像是用于特定应用程序、工具或平台，或有特定用例，请明确说明。
  • 突出关键功能或优势。简要提及区分镜像的主要优势或独特功能。例如高性能、易用性、轻量级构建或与特定框架或操作系统的兼容性。
  • 包含相关关键词。使用用户可能搜索的关键词以提高可见性，例如技术栈、用例或环境。
  • 保持简洁。描述最多可包含 100 个字符。尽量将描述控制在一两句话内，以确保在搜索结果中易于阅读。用户应能快速理解镜像的价值。
  • 关注受众。考虑您的目标受众（开发人员、系统管理员等），并编写描述以直接满足他们的需求。

遵循这些实践可以帮助使描述更具吸引力，并在搜索结果中更有效，从而为您的仓库带来更多相关流量。

添加或更新仓库描述

  1. 登录 Docker Hub。

  2. 选择 My Hub > Repositories。

    将显示您的仓库列表。

  3. 选择一个仓库。

    将显示该仓库的 General 页面。

  4. 在描述字段下选择铅笔图标。

  5. 指定描述。

    描述最多可包含 100 个字符。

  6. 选择 Update。

仓库概述

概述描述了您的镜像的功能以及如何运行它。当仓库至少有一个镜像时，概述将显示在仓库的公共视图中。如果启用了自动构建，每次成功构建时，概述将从源代码仓库的 README.md 文件同步。

请考虑以下仓库概述的最佳实践。

  • 描述镜像是什么、它提供的功能以及为什么应该使用它。可以包括使用示例或项目背后的团队。
  • 解释如何使用镜像运行容器。您可以包含在 Dockerfile 中使用镜像的最小示例。
  • 列出关键镜像变体和标签以使用它们，以及变体的用例。
  • 链接到文档或支持网站、社区或邮件列表以获取其他资源。
  • 提供镜像维护者的联系信息。
  • 包括镜像的许可证以及在哪里可以找到更多详细信息（如果需要）。

添加或更新仓库概述

  1. 登录 Docker Hub。

  2. 选择 My Hub > Repositories。

    将显示您的仓库列表。

  3. 选择一个仓库。

    将显示该仓库的 General 页面。

  4. 在 Repository overview 下，选择 Edit 或 Add overview。

    将显示 Write 和 Preview 选项卡。

  5. 在 Write 下，指定您的仓库概述。

    您可以使用基本 Markdown，并使用 Preview 选项卡预览格式。

  6. 选择 Update。

仓库分类

您可以使用分类标记 Docker Hub 仓库，代表镜像的主要预期用例。这使用户能够更轻松地找到并探索他们感兴趣的问题领域的内容。

可用分类

Docker Hub 内容团队维护一个分类列表。

类别包括：

  • API 管理：用于创建、发布、分析和保护 API 的工具。
  • 内容管理系统：通过模板、流程和标准格式来创建和管理数字内容的软件应用程序。
  • 数据科学：用于支持数据分析并生成可行见解的工具和软件。
  • 开发工具：辅助开发者创建、调试、维护和支持应用程序及系统的软件和实用程序。
  • 数据库与存储：用于存储、检索和管理数据的系统。
  • 语言与框架：编程语言运行时和框架。
  • 集成与交付：用于持续集成 (CI) 和持续交付 (CD) 的工具。
  • 物联网：支持物联网 应用程序的工具。
  • 机器学习与 AI：为人工智能和机器学习项目优化的工具和框架，例如用于数据分析、模型训练和部署的预安装库和框架。
  • 消息队列：为可靠、可扩展且高效的消息处理而优化的消息队列系统。
  • 监控与可观测性：通过指标、日志和链路追踪来跟踪软件和系统性能的工具，以及用于探索系统状态和诊断问题的可观测性工具。
  • 网络：支持数据交换以及连接计算机和其他设备以共享资源的代码库。
  • 操作系统：管理计算机上所有其他程序的软件，并作为用户与计算机硬件之间的中介，同时监督应用程序和系统资源。
  • 安全：用于保护计算机系统或网络免受硬件、软件或电子数据被盗、未经授权的访问或损坏，以及免受服务中断的工具。
  • Web 服务器：用于向用户或其他系统提供网页、HTML 文件和其他资产的软件。
  • 网站分析：用于收集、衡量、分析和报告网络数据及网站访客参与度的工具。

自动生成的分类

Note

自动生成的分类仅适用于 Docker 认证发布者（Docker Verified Publishers）和 Docker 赞助开源计划参与者（Docker-Sponsored Open Source program participants）。

对于在 Docker Hub 分类功能之前创建的仓库，已使用 OpenAI 根据仓库标题和描述自动生成并应用了分类。

作为已自动分类仓库的所有者，如果您认为分类不准确，可以手动编辑分类。请参阅管理仓库分类。

自动生成的分类是一次性努力，旨在帮助为分类功能存在之前创建的仓库添加分类。新仓库不会自动分配分类。

管理仓库分类

您可以使用最多三个分类标记仓库。

要编辑仓库的分类：

  1. 登录 Docker Hub。

  2. 选择 My Hub > Repositories。

    将显示您的仓库列表。

  3. 选择一个仓库。

    将显示该仓库的 General 页面。

  4. 在描述字段下选择铅笔图标。

  5. 选择您要应用的分类。

  6. 选择 Update。

如果您缺少某个分类，请使用 反馈链接 告诉我们您希望看到的分类。