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