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

x/website: redirect golang.org/x/<repo> to pkg.go.dev instead of godoc.org #36106

Open
hyangah opened this issue Dec 12, 2019 · 6 comments
Open

x/website: redirect golang.org/x/<repo> to pkg.go.dev instead of godoc.org #36106

hyangah opened this issue Dec 12, 2019 · 6 comments
Labels
Milestone

Comments

@hyangah
Copy link
Contributor

@hyangah hyangah commented Dec 12, 2019

No description provided.

@hyangah
Copy link
Contributor Author

@hyangah hyangah commented Dec 12, 2019

One issue I noticed is that godoc.org shows the version in the master branch, while pkg.go.dev shows the "latest released" version. For example, golang.org/x/mod shows the doc from v0.1.0 because that's the latest released version. (https://pkg.go.dev/golang.org/x/mod/semver?tab=versions) But some users may want to see the doc for the recent version commited in the master branch. pkg.go.dev currently does not provide an easy way to achieve that unless the user already knows the pseudo version mapped from the current master commit.

@julieqiu

@zikaeroh
Copy link
Contributor

@zikaeroh zikaeroh commented Dec 12, 2019

Being able to easily access master was something I reported during the private beta but hasn't happened. I'd love for there to be a link to @master in the version list and support for @master in the URL.

@bradfitz
Copy link
Contributor

@bradfitz bradfitz commented Dec 13, 2019

I wish ?tab=doc were the default without a redirect. I mean, it's already the default. I just wish it didn't redirect. The URL is much nicer without it. That's the main reason I continue to use godoc.org. Also, godoc.org gives me links to more headings.

@toothrot
Copy link
Contributor

@toothrot toothrot commented Dec 13, 2019

The redirect to ?tab=doc is a compromise while the correct default tab is being investigated, giving us some flexibility to change it in the future. (my vote is for doc)

I believe the long-term goal is for this issue to happen, but there is still some feature parity gap to close. @julieqiu knows more.

@toothrot toothrot added this to the Unreleased milestone Dec 13, 2019
@toothrot toothrot changed the title website: redirect golang.org/x/<repo> to pkg.go.dev instead of godoc.org x/website: redirect golang.org/x/<repo> to pkg.go.dev instead of godoc.org Dec 13, 2019
@gopherbot
Copy link

@gopherbot gopherbot commented May 20, 2020

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

@gopherbot gopherbot commented May 20, 2020

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
6 participants
You can’t perform that action at this time.