Skip to content

x/website: replace incorrect links to pkg.dev.go with pkg.go.dev #62225

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

Closed
alurm opened this issue Aug 22, 2023 · 3 comments
Closed

x/website: replace incorrect links to pkg.dev.go with pkg.go.dev #62225

alurm opened this issue Aug 22, 2023 · 3 comments
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. website
Milestone

Comments

@alurm
Copy link

alurm commented Aug 22, 2023

Hi.

I was reading a blog post about structured logging (https://go.dev/blog/slog) and found a typo: pkg.dev.go is written instead of pkg.go.dev.

Sentence: The best place to learn about all of slog is the [package documentation](https://pkg.dev.go/log/slog).

Notice pkg.dev.go. I think it should be pkg.go.dev.

After git grepping for 'dev\.go' in the repository I found one more post where this exact problem happens: https://go.dev/doc/articles/go_command.

Sentence part: and thus the import path of the [glog](https://pkg.dev.go/github.com/golang/glog) package is "github.com/golang/glog".

Likewise, pkg.dev.go should be replaced with pkg.go.dev, which is correct.

Patch generated with git diff:

diff --git a/_content/blog/slog.md b/_content/blog/slog.md
index b0d8bbfc..ea491c6c 100644
--- a/_content/blog/slog.md
+++ b/_content/blog/slog.md
@@ -150,7 +150,7 @@ There is a lot more to `slog`:
   among other things.
 
 The best place to learn about all of `slog` is the [package
-documentation](https://pkg.dev.go/log/slog).
+documentation](https://pkg.go.dev/log/slog).
 
 
 ## Performance
diff --git a/_content/doc/articles/go_command.html b/_content/doc/articles/go_command.html
index df689537..3a19377d 100644
--- a/_content/doc/articles/go_command.html
+++ b/_content/doc/articles/go_command.html
@@ -87,7 +87,7 @@ git clone https://github.com/golang/glog
 </pre>
 
 and thus the import path of the
-<a href="https://pkg.dev.go/github.com/golang/glog">glog</a>
+<a href="https://pkg.go.dev/github.com/golang/glog">glog</a>
 package is "<code>github.com/golang/glog</code>".</p>
 
 <p>These paths are on the long side, but in exchange we get an
@gopherbot gopherbot added this to the Unreleased milestone Aug 22, 2023
@ianlancetaylor
Copy link
Contributor

Thanks, sent https://go.dev/cl/522075 to fix this.

@gopherbot
Copy link
Contributor

Change https://go.dev/cl/522075 mentions this issue: _content/blog/slog: correct doc link

@alurm
Copy link
Author

alurm commented Aug 23, 2023

@ianlancetaylor awesome, thanks!

Although I don't see change to _content/doc/articles/go_command.html mentioned in the change list (it needs the same one line fix, as I said in the comment above).

Perhaps, it should be changed as well, seems very much of the same mistake to me. Or should I create a new issue?

Edit: I see that the second change is present in the change list as well now. Thanks!

@dmitshur dmitshur added NeedsFix The path to resolution is known, but the work has not been done. Documentation Issues describing a change to documentation. labels Aug 23, 2023
@golang golang locked and limited conversation to collaborators Aug 22, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge NeedsFix The path to resolution is known, but the work has not been done. website
Projects
None yet
Development

No branches or pull requests

4 participants