Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

go.dev: open source pkg.go.dev #36747

Closed
marwan-at-work opened this issue Jan 24, 2020 · 19 comments
Closed

go.dev: open source pkg.go.dev #36747

marwan-at-work opened this issue Jan 24, 2020 · 19 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite

Comments

@marwan-at-work
Copy link
Contributor

Hi there,
I know this topic must have come up a lot but I haven't found an open issue for it.

Will pkg.go.dev ever be open sourced?

It would be incredibly useful for companies running a documentation server internally especially if pkg.go.dev spoke the GOPROXY download protocol and a company had an internal GOPROXY as well.

Thanks!

@toothrot toothrot added this to the Unreleased milestone Jan 24, 2020
@toothrot toothrot added pkgsite NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Jan 24, 2020
@tv42
Copy link

tv42 commented Jan 26, 2020

I'm amazed I can't quickly find the source. I want to know what the exact criteria passed to the license checker is, to get my project above whatever detection threshold you use.

Frankly, this reflects poorly on the Go project.

tv42 added a commit to tv42/representative that referenced this issue Jan 26, 2020
https://pkg.go.dev couldn't detect a license with a mere 78% match.
The exact criteria is unknown because in a wtf move go.dev is
proprietary (golang/go#36747). Minimize
prose to gain an extra 10% of match and hope that that's good enough;
the way go.dev is being force fed on the community sucks.
@mvdan
Copy link
Member

mvdan commented Jan 29, 2020

I also think it would be depressing if godoc.org starts redirecting to pkg.go.dev, a site that's entirely closed source. The Go project has been built on open source since the very early days, so this seems to go directly against its history. The forced switch would be a significant downgrade.

It's also discouraging that https://go.dev talks so much about the power of open source, but the first major product that comes from it is a black box.

@qaisjp
Copy link
Contributor

qaisjp commented Jan 31, 2020

I'm amazed I can't quickly find the source. I want to know what the exact criteria passed to the license checker is, to get my project above whatever detection threshold you use.

Frankly, this reflects poorly on the Go project.

I want go.dev and pkg.go.dev to be open source too. But the bit that you're asking for is already open source: https://github.com/google/licensecheck

@tv42
Copy link

tv42 commented Feb 1, 2020

@qaisjp licensecheck lists probabilities, the yes/no decision criteria is hidden in pkg.go.dev.

@rsc
Copy link
Contributor

rsc commented Feb 3, 2020

This general topic also came up on golang-dev over the weekend, and I wrote a long reply there:
https://groups.google.com/d/msg/golang-dev/mfiPCtJ1BGU/qtCrqlrEEwAJ

It would be incredibly useful for companies running a documentation server internally especially if pkg.go.dev spoke the GOPROXY download protocol and a company had an internal GOPROXY as well.

Agreed. I definitely want to open source a server like that. I am not convinced that pkg.go.dev in its current form is the right server for "companies running a documentation server internally" - I think we can and should aim a little higher and differently for that. See my mailing list reply for more about that.

But even if we release a different server as the best thing to run in non-global-scale settings, we should still look more carefully at open-sourcing pkg.go.dev's code, as an example if nothing else. As I said in the mail, I am going to look into that.

@qaisjp
Copy link
Contributor

qaisjp commented Feb 4, 2020

This general topic also came up on golang-dev over the weekend, and I wrote a long reply there:
groups.google.com/g/golang-dev/c/mfiPCtJ1BGU/m/qtCrqlrEEwAJ

That link didn't work for me. This one does, though: https://groups.google.com/d/msg/golang-dev/mfiPCtJ1BGU/qtCrqlrEEwAJ

p.s. i'm quite satisfied with that reply. thank you!

@julieqiu
Copy link
Member

In case anyone following this issue has not seen @rsc's post on golang-dev, we are working towards open sourcing pkg.go.dev!

Updates will be posted on this issue.

@julieqiu julieqiu added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Feb 29, 2020
@l0nax
Copy link

l0nax commented Mar 3, 2020

@julieqiu can you give an approximate date when this will be the case?

@julieqiu
Copy link
Member

julieqiu commented Mar 3, 2020

Not at the moment - we're still figuring out the details for what is involved with open sourcing the site. We'll post on this issue once we have an update!

@carnott-snap
Copy link

I get that you are not able to commit to anything, but can we get an order of magnitude? (e.g. days, weeks, months, or years)

@mvdan
Copy link
Member

mvdan commented Mar 3, 2020

@carnott-snap given that their initial plan was to phase out godoc.org towards the end of 2020, and that the codebase will probably require some work before being open sourced, one can imagine it's in the order of months.

@julieqiu
Copy link
Member

julieqiu commented Mar 3, 2020

+1 to @mvdan's comment - on the order of months. We are planning to open source before traffic from godoc.org is redirected to pkg.go.dev.

@gopherbot
Copy link

Change https://golang.org/cl/222737 mentions this issue: repos: add golang.org/x/discovery repository

gopherbot pushed a commit to golang/build that referenced this issue May 19, 2020
For golang/go#36747.

Change-Id: I1fdf70248fc0ba4643b56a6d3f7fb3b690a549a5
Reviewed-on: https://go-review.googlesource.com/c/build/+/222737
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
@gopherbot
Copy link

Change https://golang.org/cl/234677 mentions this issue: repos: add API for opting-in to use pkg.go.dev for documentation

gopherbot pushed a commit to golang/build that referenced this issue May 20, 2020
The golang.org/x/pkgsite repository is the first one that needs it.

For golang/go#39150.
For golang/go#36747.
For golang/go#36106.

Change-Id: I7fa38cbe7d5d92012bb00f9c4587f60d06a94199
Reviewed-on: https://go-review.googlesource.com/c/build/+/234677
Reviewed-by: Julie Qiu <julie@golang.org>
@gopherbot
Copy link

Change https://golang.org/cl/234678 mentions this issue: cmd/golangorg: add golang.org/x/pkgsite repository

gopherbot pushed a commit to golang/website that referenced this issue May 20, 2020
Allow golang.org/x repos to opt-in to use pkg.go.dev for documentation.
The golang.org/x/pkgsite repository is the first one to use it.

Update to current golang.org/x/build version and regenerate:

	go get golang.org/x/build/repos@92427f67eca1ac8f769c740f272196f368082630
	go mod tidy
	go generate ./...

Fixes golang/go#39150.
For golang/go#36747.
For golang/go#36106.

Change-Id: Ia91725c12546c4e7467601d951144af3cb1e6863
Reviewed-on: https://go-review.googlesource.com/c/website/+/234678
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Julie Qiu <julie@golang.org>
@julieqiu
Copy link
Member

Pkg.go.dev is now open source! You can find the codebase at go.googlesource.com/pkgsite. The repository is also mirrored to github.com/golang/pkgsite. For details, see blog.golang.org/pkgsite.

@marwan-at-work
Copy link
Contributor Author

That's very exciting, thank you all for your work open sourcing this to the community!

@mvdan
Copy link
Member

mvdan commented Jun 15, 2020

@julieqiu perhaps you could confirm if the project will use this issue tracker as the only source of truth going forward, like gopls? I know we started using issues a while back, but as far as I understand it was still partly a mirror of sorts, where the actual fixes and deployments were tracked internally. It would be nice if all of that now happened here too.

I'm also interested to know if the existing issues are up to date with what's been open sourced, or if someone should update the issue tracker

@julieqiu
Copy link
Member

We do plan to continue using only the Go issue tracker for x/pkgsite. You can continue filing issues using this template.

The existing issues related to pkg.go.dev should be up to date. We will continue using the go.dev label to track issues. I plan to add the help wanted label to relevant issues later today.

Additional details are in the blog post and contributing guidelines :)

@golang golang locked and limited conversation to collaborators Jul 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. pkgsite
Projects
None yet
Development

No branches or pull requests

10 participants