仓库信息
每个仓库都可以包含描述、概览和类别,以帮助用户了解其用途和使用方法。添加清晰的仓库信息可确保其他人能够找到您的镜像并有效使用它们。
您只能修改未归档仓库的仓库信息。如果仓库已归档,您必须取消归档才能修改信息。有关更多详细信息,请参阅取消归档仓库。
仓库描述
使用 docker search
命令时,描述会出现在搜索结果中,也会出现在 Docker Hub 的搜索结果中。
请考虑以下仓库描述最佳实践。
- 总结用途。清晰、简洁、具体地说明镜像的作用。明确指出它是否适用于特定应用、工具、平台,或者具有独特的用例。
- 突出关键特性或优势。简要提及区分镜像的主要优势或独特功能。例如,高性能、易用性、轻量级构建,或与特定框架或操作系统的兼容性。
- 包含相关关键词。使用用户可能搜索的关键词来提高可见性,例如技术栈、用例或环境。
- 保持简洁。描述最多可包含 100 个字符。尽量将描述控制在一到两句话内,以确保在搜索结果中易于阅读。用户应能快速了解镜像的价值。
- 关注受众。考虑您的目标受众(开发者、系统管理员等),并直接针对他们的需求撰写描述。
遵循这些实践有助于使描述在搜索结果中更具吸引力和有效性,从而为您的仓库带来更多相关流量。
添加或更新仓库描述
登录 Docker Hub。
选择 我的 Hub > 仓库。
将显示您的仓库列表。
选择一个仓库。
将显示该仓库的常规页面。
选择描述字段下的铅笔图标。
指定描述。
描述最多可包含 100 个字符。
选择更新。
仓库概览
概览描述了您的镜像的功能以及如何运行它。当仓库中至少包含一个镜像时,概览将显示在仓库的公开视图中。如果启用了自动化构建,概览将在每次成功构建后从源代码仓库的 README.md
文件同步。
请考虑以下仓库概览最佳实践。
- 描述镜像是什么、它提供的功能以及为何应使用它。可包含使用示例或项目背后的团队信息。
- 解释如何开始使用该镜像运行容器。您可以包含一个在 Dockerfile 中使用该镜像的最小示例。
- 列出关键镜像变体及其使用的标签,以及变体的用例。
- 链接到文档或支持站点、社区或邮件列表以获取额外资源。
- 提供镜像维护者的联系信息。
- 包含镜像的许可信息,并在需要时说明在哪里查找更多详细信息。
添加或更新仓库概览
登录 Docker Hub。
选择 我的 Hub > 仓库。
将显示您的仓库列表。
选择一个仓库。
将显示该仓库的常规页面。
在仓库概览下,选择编辑或添加概览。
将显示编写和预览选项卡。
在编写下,指定您的仓库概览。
您可以使用基本 Markdown,并使用预览选项卡预览格式。
选择更新。
仓库类别
您可以为 Docker Hub 仓库添加类别标签,这些标签代表了您镜像的主要预期用例。这使用户可以更轻松地找到并浏览他们感兴趣的问题领域的内容。
可用类别
Docker Hub 内容团队维护着一个精选的类别列表。
类别包括
- API 管理:用于创建、发布、分析和保护 API 的工具。
- 内容管理系统:通过模板、程序和标准格式创建和管理数字内容的软件应用。
- 数据科学:支持分析数据并生成可操作洞察的工具和软件。
- 数据库与存储:用于存储、检索和管理数据的系统。
- 语言与框架:编程语言运行时和框架。
- 集成与交付:用于持续集成 (CI) 和持续交付 (CD) 的工具。
- 物联网:支持物联网 (IoT) 应用的工具。
- 机器学习与 AI:针对人工智能和机器学习项目优化的工具和框架,例如用于数据分析、模型训练和部署的预安装库和框架。
- 消息队列:针对可靠、可扩展和高效消息处理优化的消息队列系统。
- 监控与可观测性:通过指标、日志和跟踪来跟踪软件和系统性能的工具,以及用于探索系统状态和诊断问题的可观测性工具。
- 网络:支持数据交换以及连接计算机和其他设备以共享资源的仓库。
- 操作系统:管理计算机上所有其他程序并充当用户与计算机硬件之间中介的软件,同时监督应用程序和系统资源。
- 安全:保护计算机系统或网络免遭盗窃、未经授权的访问、硬件、软件或电子数据损坏以及服务中断的工具。
- Web 服务器:向用户或其他系统提供网页、HTML 文件及其他资源的软件。
- Web 分析:收集、衡量、分析和报告网站数据及网站访客参与度的工具。
自动生成类别
注意
自动生成类别仅适用于 Docker 认证发布者和 Docker 赞助的开源计划参与者。
对于早于 Docker Hub 中类别功能的仓库,已根据仓库标题和描述使用 OpenAI 自动生成并应用了类别。
作为已自动分类仓库的所有者,如果您认为类别不准确,可以手动编辑类别。请参阅管理仓库类别。
自动生成分类是一项一次性工作,旨在帮助为在该功能推出前创建的仓库填充类别。新仓库不会自动分配类别。
管理仓库类别
您可以为一个仓库添加最多三个类别标签。
要编辑仓库的类别
登录 Docker Hub。
选择 我的 Hub > 仓库。
将显示您的仓库列表。
选择一个仓库。
将显示该仓库的常规页面。
选择描述字段下的铅笔图标。
选择您想要应用的类别。
选择更新。
如果您缺少某个类别,请使用提供反馈链接告知我们您希望看到哪些类别。