Go 博客

pkg.go.dev 的下一步

Julie Qiu
2020 年 1 月 31 日

引言

2019 年,我们推出了 go.dev,一个面向 Go 开发者的全新中心。

作为网站的一部分,我们还推出了 pkg.go.dev,这是一个关于 Go 包和模块的中心信息源。与 godoc.org 一样,pkg.go.dev 提供 Go 文档。然而,它也理解模块,并包含有关包过往版本的信息!

在今年内,我们将向 pkg.go.dev 添加更多功能,以帮助用户更好地理解其依赖项,并帮助他们更好地决定导入哪些库。

将 godoc.org 请求重定向到 pkg.go.dev

为了最大限度地减少使用哪个网站的困惑,我们计划在今年晚些时候将来自 godoc.org 的流量重定向到 pkg.go.dev 上的相应页面。我们需要您的帮助,以确保 pkg.go.dev 满足我们所有用户的需求。我们鼓励大家现在就开始使用 pkg.go.dev 来满足所有需求并提供反馈。

您的反馈将为我们的过渡计划提供信息,目标是将 pkg.go.dev 打造成我们包和模块的主要信息和文档来源。我们确信您希望在 pkg.go.dev 上看到某些功能,我们希望听取您关于这些功能的意见!

您可以通过以下渠道与我们分享您的反馈

作为此次过渡的一部分,我们还将讨论 pkg.go.dev 的 API 访问计划。我们将在 Go issue 33654 上发布更新。

常见问题

自 11 月发布以来,我们收到了 Go 用户关于 pkg.go.dev 的大量精彩反馈。在本文的其余部分,我们认为回答一些常见问题会很有帮助。

我的包没有显示在 pkg.go.dev 上!如何添加?

我们会定期监控 Go 模块索引 以便将新包添加到 pkg.go.dev。如果您在 pkg.go.dev 上没有看到某个包,可以通过从 proxy.golang.org 获取模块版本来添加它。请参阅 go.dev/about 获取说明。

我的包有许可证限制。这是怎么回事?

我们理解在 pkg.go.dev 上无法完整看到您想要的包可能会令人沮丧。感谢您的耐心等待,我们正在改进许可证检测算法。

自 11 月发布以来,我们已做出以下改进:

  • 更新了我们的许可证政策,包含我们检测和识别的许可证列表
  • licensecheck 团队合作,改进版权声明的检测
  • 建立了特殊情况的手动审查流程

一如既往,我们的许可证政策位于 pkg.go.dev/license-policy。如果您遇到问题,请随时在 Go issue tracker 上提交问题,或发送电子邮件至 go-discovery-feedback@google.com,以便我们直接与您合作!

pkg.go.dev 会开源吗,以便我在工作中使用它处理我的私有代码?

我们理解拥有私有代码的公司希望运行支持模块的文档服务器。我们希望帮助满足这一需求,但我们认为我们对此的理解还不够深入。

我们从用户那里了解到,运行 godoc.org 服务器比应有的复杂,因为它设计用于公共互联网规模的服务,而非仅限于公司内部。我们认为当前的 pkg.go.dev 服务器也会存在同样的问题。

我们认为,对于私有代码的使用,一个新服务器更有可能是正确的解决方案,而不是让每家公司都面临运行互联网规模的 pkg.go.dev 代码库的复杂性。除了提供文档服务外,新服务器还可以向 goimportsgopls 提供信息。

如果您希望运行这样的服务器,请填写这份3-5 分钟的调查问卷,以帮助我们更好地了解您的需求。本次调查问卷将于 2020 年 3 月 1 日截止。

我们对 2020 年 pkg.go.dev 的未来感到兴奋,希望您也一样!我们期待收到您的反馈,并与 Go 社区一起推进此次过渡。

下一篇文章:Go 1.14 已发布
上一篇文章:Go 1.15 提案
博客索引