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.

Sign up for GitHub

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

Jump to bottom

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

Closed
hyangah opened this issue Dec 12, 2019 · 10 comments
Closed

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

hyangah opened this issue Dec 12, 2019 · 10 comments
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@hyangah
Copy link
Contributor

hyangah commented Dec 12, 2019

No description provided.

@hyangah
Copy link
Contributor Author

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

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 commented Dec 13, 2019 •
edited

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

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 added the NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. label 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
@dmitshur dmitshur added NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. and removed NeedsInvestigation Someone must examine and confirm this is a valid issue and not a duplicate of an existing one. labels Dec 16, 2019
@julieqiu julieqiu mentioned this issue May 19, 2020
Closed
@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
@dmitshur
repos: add API for opting-in to use pkg.go.dev for documentation
92427f6 
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
@dmitshur
cmd/golangorg: add golang.org/x/pkgsite repository
050186b 
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>
@gopherbot
Copy link

Change https://golang.org/cl/275235 mentions this issue: godoc: change godoc.org links to pkg.go.dev

@gopherbot
Copy link

Change https://golang.org/cl/275195 mentions this issue: all: replace godoc.org links with pkg.go.dev

gopherbot pushed a commit to golang/tools that referenced this issue Dec 7, 2020
@julieqiu
godoc: change godoc.org links to pkg.go.dev
05664e2 
Links to godoc.org pages are changed to link to pkg.go.dev.

CL 253017 and CL 234678 are also backported.

For golang/go#36106

Change-Id: I6a875f5b43e456f11d8eeccfc5ef647a5501c4d3
Reviewed-on: https://go-review.googlesource.com/c/tools/+/275235
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
gopherbot pushed a commit to golang/website that referenced this issue Dec 7, 2020
@julieqiu
all: replace godoc.org links with pkg.go.dev
9bb0e23 
Change links from godoc.org to pkg.go.dev.

For golang/go#36106

Change-Id: Ic3ec03efc265cdc332027d538b0c5d4d91bdac24
Reviewed-on: https://go-review.googlesource.com/c/website/+/275195
Trust: Julie Qiu <julie@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
marwan-at-work pushed a commit to marwan-at-work/tools that referenced this issue Dec 23, 2020
@julieqiu @marwan-at-work
godoc: change godoc.org links to pkg.go.dev
eb0030b 
Links to godoc.org pages are changed to link to pkg.go.dev.

CL 253017 and CL 234678 are also backported.

For golang/go#36106

Change-Id: I6a875f5b43e456f11d8eeccfc5ef647a5501c4d3
Reviewed-on: https://go-review.googlesource.com/c/tools/+/275235
Trust: Julie Qiu <julie@golang.org>
Run-TryBot: Julie Qiu <julie@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org>
@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. and removed NeedsDecision Feedback is required from experts, contributors, and/or the community before a change can be made. labels Feb 4, 2021
@gopherbot
Copy link

Change https://golang.org/cl/289700 mentions this issue: repos: remove unused Repo.UsePkgGoDev

@dmitshur
Copy link
Contributor

dmitshur commented Feb 4, 2021

This is done as of CL 275195.

@dmitshur dmitshur closed this as completed Feb 4, 2021
gopherbot pushed a commit to golang/build that referenced this issue Feb 4, 2021
@dmitshur
repos: remove unused Repo.UsePkgGoDev
96687b6 
UsePkgGoDev was added in CL 234677 to aid with a gradual migration
on golang.org. That redirection has been completed as of CL 275195,
and UsePkgGoDev is no longer meaningful nor used. Remove it, since
it's allowed per x/build's compatibilty policy, to keep things tidy.

Updates golang/go#36106.
Updates golang/go#39150.

Change-Id: If3f9bed7f215a7c572a2d7a9f25b3184a1e5362a
Reviewed-on: https://go-review.googlesource.com/c/build/+/289700
Trust: Dmitri Shuralyov <dmitshur@golang.org>
Run-TryBot: Dmitri Shuralyov <dmitshur@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Alexander Rakoczy <alex@golang.org>
@golang golang locked and limited conversation to collaborators Feb 4, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
6 participants
@bradfitz @toothrot @dmitshur @hyangah @gopherbot @zikaeroh