ZenML项目API文档迁移指南

背景介绍

ZenML作为一个开源的机器学习运维(MLOps)框架，其文档系统经历了多次迭代升级。近期有用户反馈在查找CLI命令文档时遇到了困惑，这引发了我们对文档系统现状的梳理。

文档系统变更

ZenML的API文档已经从原先的apidocs.zenml.io迁移到了新的sdkdocs.zenml.io平台。这一变更带来了以下改进：

1. 内容更加全面和及时更新
2. 文档组织结构更加清晰
3. 搜索功能得到增强

如何查找CLI文档

对于需要查阅ZenML命令行接口(CLI)文档的用户，现在可以通过以下方式获取最新信息：

1. 直接访问sdkdocs.zenml.io
2. 在文档中查找"CLI"相关章节
3. 查看特定版本的CLI文档，例如0.82.0版本的CLI文档

常见问题解答

为什么找不到旧版文档？
旧版文档站点(apidocs.zenml.io)已经停止更新，现在会自动重定向到新版文档站点。

如何确认文档版本？
文档URL中会包含版本号信息，例如0.82.0表示这是0.82.0版本的文档。

CLI文档包含哪些内容？
CLI文档详细介绍了所有可用的命令行工具及其参数选项，包括用户管理、流水线操作等核心功能。

最佳实践建议

1. 始终使用最新版本的文档
2. 通过官方文档站点获取信息，而非第三方来源
3. 遇到文档问题时，可以查阅项目的GitHub仓库获取帮助

总结

ZenML团队持续优化文档系统，为用户提供更好的使用体验。了解文档系统的变更历史和使用方法，将帮助开发者更高效地使用ZenML框架进行机器学习项目的开发和部署。