commit: 969865f3a9b42d76623a29db0c5ac9d3142b0e22 parent 6b9c94eec9fa73c2bbed4267534f5a23aebb16ee Author: Drew DeVault <sir@cmpwn.com> Date: Tue, 19 Jan 2021 12:50:35 -0500 Rewrite godocs.ioDiffstat:
| M | content/blog/godocs.io.md | 59 | +++++++++++++---------------------------------------------- |
1 file changed, 13 insertions(+), 46 deletions(-)
diff --git a/content/blog/godocs.io.md b/content/blog/godocs.io.md @@ -3,49 +3,16 @@ title: godocs.io is now available date: 2020-12-18 --- -The inevitable forced migration to pkg.go.dev is shipping with known -regressions. It's rolling on out without fixing, for example, [a problem I -pointed out in June](https://github.com/golang/go/issues/38986). godoc.org uses -special meta tags[^1] which can link up a source path and line number with a URL -for a git host's source view. pkg.go.dev instead hardcodes a list of hosted git -forges. git.sr.ht is among them — getting it added was my introduction to -this mess — but *only* the hosted instance, and no third-party git.sr.ht -instances. hg.sr.ht is still missing, too. The Go team committed to not shipping -with regressions, but that was (predictably) false. - -I have [previously written about][previous] the botched pkg.go.dev roll-out. -It's a microcosm of Google's toxic engineering culture, demonstrating how Google -engineers are out-of-touch with the values and needs of their community. It -initially shipped as a proprietary replacement, with no intention of making it -open source until the community demanded it, under the rationale that it wasn't -useful for intranets.[^2] They didn't take the opportunity to address any of the -flaws in godoc.org's design, and instead introduced regressions and made those -flaws even worse. - -And it's shipping, in this state, in Q1 2021. - -This pattern appears to be common to many Google affairs, because it's the -primary means by which Googlers get promoted. - -[previous]: https://drewdevault.com/2020/08/01/pkg-go-dev-sucks.html - -In light of this, [godocs.io](https://godocs.io) is now available, running the -last version of godoc.org that pre-dates pkg.go.dev. It is my intention to keep -this running indefinitely, and you're welcome to use it for your own purposes or -projects. - -I haven't made any especially interesting changes, but the source code [is -available on git.sr.ht](https://git.sr.ht/~sircmpwn/gddo) — feel free to -send patches along to [sir@cmpwn.com](mailto:sir@cmpwn.com) if you want to -submit (minor) improvements or bugfixes. One change I will definitely have to -make is a new solution for full-text search (probably just Postgres), because I -don't want to use AppEngine. If anyone wants to help with this, I would -appreciate your patch. - -[^1]: Which have problems of their own, which, when I raised them, where quickly dismissed by the Go team. -[^2]: "Useful for intranets" is obviously not the defining reason why FOSS projects are good. - -Update: [implemented full-text search](https://git.sr.ht/~sircmpwn/gddo/commit/c916d5629996d6a4cbd67e48e25af40a966b5d69) -on top of Postgres in about 30 minutes with a friend's help. Aside from the -dataset (which will grow naturally as the service is used), this should be for -all intents and purposes equivalent to pre-pkg.go.dev godoc.org now. Enjoy! +Due to the coming sunsetting of godoc.org in favor of pkg.go.dev, I'm happy to +announce that [godocs.io](https://godocs.io) is now available as a replacement. +We have [forked the codebase](https://sr.ht/~sircmpwn/godocs.io) and cleaned +things up quite a bit, removing lots of dead or obsolete features, cleaning out +a bunch of Google-specific code and analytics, reducing the JavaScript +requirements, and rewriting the search index for Postgres. We will commit to its +maintenance going forward for anyone who prefers the original godoc.org +experience over the new website. + +Notice: this article was rewritten on 2021-01-19. The original article has a lot +of unnecessary salt. [You can read the original here][original]. + +[original]: https://git.sr.ht/~sircmpwn/drewdevault.com/tree/fa8799c882f6555606e0a906bd8e0a484bb51398/item/content/blog/godocs.io.md