Skip to content

x/website: The Go installation docs should mention the option to add $GOBIN to $PATH #66043

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
Battlesheepu opened this issue Mar 1, 2024 · 1 comment
Labels
Documentation Issues describing a change to documentation. FrozenDueToAge pkgsite website
Milestone

Comments

@Battlesheepu
Copy link

Battlesheepu commented Mar 1, 2024

What is the URL of the page with the issue?

https://go.dev/doc/install

What is your user agent?

Mozilla/5.0 (X11; Ubuntu; Linux x86_64; rv:123.0) Gecko/20100101 Firefox/123.0

Screenshot

No response

What did you do?

Successfully visited the Go docs for the installation process.

What did you see happen?

I saw no mention of adding $GOBIN to $PATH, which is assumed for some of the packages from the Go project.

What did you expect to see?

Many of the commands belonging to packages in the Go project repos (like pkgsite, bent, govulncheck, among others) seem to assume that users have added $GOBIN to their $PATH, providing usage instructions based on just that.

Thing is, with the exclusion of docs for installing Go from source, I haven't seen this suggested or mentioned neither in the installation docs nor in the output of go help install.

I strongly believe that, especially for people starting out with the language, it's not immediately obvious that those commands would be, by default, installed into $GOBIN - which, in my opinion, is not terribly problematic, as long as we get some kind of a hint regarding adding $GOBIN to the $PATH. This would also compliment the package documentation pretty nicely, with things working out of the box when following instructions in the aforementioned packages description.

I did have a short conversation in the go-nuts Google group about this before deciding to file an issue, so I do hope I'm not the only one that change would make sense to. In terms of the context of that discussion, I think a simple mention of the matter in the installation docs would probably go a long way.

Thanks in advance!

@gopherbot gopherbot added this to the Unreleased milestone Mar 1, 2024
@gopherbot gopherbot added the Documentation Issues describing a change to documentation. label Mar 1, 2024
@seankhliao
Copy link
Member

Duplicate of #44930

@seankhliao seankhliao marked this as a duplicate of #44930 Mar 1, 2024
@seankhliao seankhliao closed this as not planned Won't fix, can't repro, duplicate, stale Mar 1, 2024
@golang golang locked and limited conversation to collaborators Mar 1, 2025
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 pkgsite website
Projects
None yet
Development

No branches or pull requests

3 participants