存储库信息

每个存储库都可以包含描述、概述和类别以提供帮助 用户了解其用途和用途。添加明文仓库信息 确保其他人可以找到您的镜像并有效地使用它们。

您只能修改不是 存档。如果存储库已存档,则必须取消存档才能修改 信息。有关更多详细信息,请参阅取消存档存储库

存储库描述

使用命令时,描述将显示在搜索结果中 以及 Docker Hub 上的搜索结果中。docker search

请考虑以下存储库描述最佳实践。

  • 总结目的。以简洁明了的方式清楚地说明镜像的作用 具体的方式。明确它是针对特定应用程序、工具还是 平台,或者具有不同的用例。
  • 突出主要功能或优势。简要提及主要好处或 区分镜像的独特功能。示例包括 high 性能、易用性、轻量级构建或与特定 框架或操作系统。
  • 包含相关关键词。使用用户可能搜索的关键词来增加 可见性,例如技术堆栈、用例或环境。
  • 保持简洁。描述最多可包含 100 个字符。旨在 请保持在一两句话以内进行描述,以确保它易于 在搜索结果中读取。用户应快速了解镜像的价值。
  • 关注受众。考虑您的目标受众(开发者、系统 管理员等)并编写描述以满足他们的需求 径直。

遵循这些做法有助于使描述更具吸引力,并且 在搜索结果中有效,为您的仓库带来更多相关流量。

添加或更新仓库描述

  1. 登录到 Docker Hub

  2. 选择 Repositories (存储库)。

    此时将显示您的存储库列表。

  3. 选择存储库。

    此时将显示存储库的 General (常规) 页面。

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

  5. 指定描述。

    描述最长可达 100 个字符。

  6. 选择 Update (更新)。

存储库概述

概述描述了您的镜像的作用以及如何运行它。它显示在 public 视图(当仓库至少有一个镜像时)。如果 启用自动生成,则 overview 将从源代码同步 repository 的文件。README.md

请考虑以下存储库概述最佳实践。

  • 描述镜像是什么、它提供的功能以及为什么应该使用它。 可以包括使用示例或项目背后的团队。
  • 说明如何开始使用镜像运行容器。您可以 包括如何在 Dockerfile 中使用镜像的最小示例。
  • 列出关键镜像变体和使用它们的标记,以及 变种。
  • 链接到文档或支持站点、社区或邮件列表 其他资源。
  • 提供镜像维护人员的联系信息。
  • 包括镜像的许可证以及查找更多详细信息的位置(如果需要)。

添加或更新仓库概述

  1. 登录到 Docker Hub

  2. 选择 Repositories (存储库)。

    此时将显示您的存储库列表。

  3. 选择存储库。

    此时将显示存储库的 General (常规) 页面。

  4. Repository overview(存储库概述)下,选择 Edit(编辑)或 Add overview(添加概述)。

    此时将显示 WritePreview 选项卡。

  5. Write (写入) 下,指定您的存储库概述。

    您可以使用基本的 Markdown 并使用 Preview (预览) 选项卡来预览格式。

  6. 选择 Update (更新)。

仓库类别

您可以使用类别标记 Docker Hub 存储库,这些类别表示主要 镜像的预期用例。这使用户可以更轻松地找到和 浏览他们感兴趣的问题域的内容。

可用类别

Docker Hub 内容团队维护着一个精选的类别列表。 可用类别包括:

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

自动生成的类别

注意

自动生成的类别仅适用于 Docker 验证发布者和 Docker 赞助的开源计划参与者。

对于早于 Docker Hub 中的类别功能的存储库, 类别已使用 OpenAI 自动生成和应用 在 repository title (存储库标题) 和 description (描述) 上。

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

自动生成的分类是帮助设定类别的种子的一次性工作 添加到该功能存在之前创建的存储库中。类别不是 自动分配给新存储库。

管理仓库的类别

您最多可以使用三个类别来标记存储库。

要编辑仓库的类别:

  1. 登录到 Docker Hub

  2. 选择 Repositories (存储库)。

    此时将显示您的存储库列表。

  3. 选择存储库。

    此时将显示存储库的 General (常规) 页面。

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

  5. 选择要应用的分类。

  6. 选择 Update (更新)。

如果您缺少某个分类,请使用【提供反馈】链接告诉我们您希望查看哪些分类。