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

doc: cmd/go: some module docs are on swtch.com, not golang.org #27220

Open
wsc1 opened this issue Aug 25, 2018 · 5 comments
Open

doc: cmd/go: some module docs are on swtch.com, not golang.org #27220

wsc1 opened this issue Aug 25, 2018 · 5 comments
Labels
Documentation modules NeedsFix The path to resolution is known, but the work has not been done.
Milestone

Comments

@wsc1
Copy link

wsc1 commented Aug 25, 2018

Please answer these questions before submitting your issue. Thanks!

What version of Go are you using (go version)?

golang.org today

Does this issue reproduce with the latest release?

yes

What operating system and processor architecture are you using (go env)?

I don't think it matters

What did you do?

went to golang.org
If possible, provide a recipe for reproducing the error.
A complete runnable program is good.
A link on play.golang.org is best.

What did you expect to see?

Documentation for the go programming language to be hosted on golang.org

What did you see instead?

Documentation for go modules hosted on swtch.com

@ALTree
Copy link
Member

ALTree commented Aug 25, 2018

It's not clear what is it that is only available on swtch.com and you'd like to see on golang.org. Can you expand?

@ALTree ALTree added WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. modules labels Aug 25, 2018
@ALTree ALTree changed the title golang.org documentation not self-contained doc: golang.org documentation not self-contained Aug 25, 2018
@wsc1
Copy link
Author

wsc1 commented Aug 25, 2018

Yes, but I cannot elaborate it all without going through everything.

There are some links I came across, mostly in the https://golang.org/cmd/go/ page
which refer to swtch.com for information not present on golang.org.

To my taste, I would prefer golang.org docs be self contained.

With full understanding it's not up to me; just would like to express the opinion that
the implications of pointing to a .com from a .org for more info don't sit well, and would ideally be self-contained. nothing against the content of swtch.com intended.

@ianlancetaylor
Copy link
Contributor

It's not reasonable for us to refuse to link to any other site from golang.org. For example, https://golang.org/pkg/html/template/ links to rawgit.com. https://golang.org/pkg/archive/zip/ links to pkware.com. I'm sure there are many other examples.

That said, yes, the vgo information on swtch.com is Go-specific and could reasonably move to golang.org. Modules are currently an experimental facility. Let's revisit this when we are closer to the 1.12 release.

@ianlancetaylor ianlancetaylor removed the WaitingForInfo Issue is not actionable because of missing required information, which needs to be provided. label Aug 25, 2018
@ianlancetaylor ianlancetaylor added this to the Go1.12 milestone Aug 25, 2018
@ianlancetaylor ianlancetaylor changed the title doc: golang.org documentation not self-contained doc: some module docs are on swtch.com, not golang.org Aug 25, 2018
@wsc1
Copy link
Author

wsc1 commented Aug 25, 2018

Yes of course I meant go specific documentation, but should have specified.

Last I checked, the detailed assembler docs were old plan9 and I think off-site, but now it appears correctly referenced as background at 9p.io.

@bradfitz bradfitz added the NeedsFix The path to resolution is known, but the work has not been done. label Aug 25, 2018
@agnivade
Copy link
Contributor

There are currently 3 links to https://research.swtch.com/ in the cmd/go page.

Only Modular code layout leans heavily on research.swtch.com saying -

For now, see https://research.swtch.com/vgo-module for information about how source code in version control systems is mapped to module file trees.

All others just have supplemental material ponting to research.swtch.com.

@rsc - Do you have plans to move some of the modular code layout section inside golang.org ?

@andybons andybons modified the milestones: Go1.12, Go1.13 Feb 12, 2019
@bcmills bcmills changed the title doc: some module docs are on swtch.com, not golang.org doc: cmd/go: some module docs are on swtch.com, not golang.org Apr 8, 2019
@andybons andybons modified the milestones: Go1.13, Go1.14 Jul 8, 2019
@rsc rsc modified the milestones: Go1.14, Backlog Oct 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation modules NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Development

No branches or pull requests

8 participants