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