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: some module docs are on swtch.com, not golang.org #27220

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

Comments

Projects
None yet
6 participants
@wsc1

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

This comment has been minimized.

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 changed the title from golang.org documentation not self-contained to doc: golang.org documentation not self-contained Aug 25, 2018

@wsc1

This comment has been minimized.

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

This comment has been minimized.

Contributor

ianlancetaylor commented Aug 25, 2018

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 added this to the Go1.12 milestone Aug 25, 2018

@ianlancetaylor ianlancetaylor changed the title from doc: golang.org documentation not self-contained to doc: some module docs are on swtch.com, not golang.org Aug 25, 2018

@wsc1

This comment has been minimized.

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 label Aug 25, 2018

@agnivade

This comment has been minimized.

Member

agnivade commented Nov 15, 2018

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 ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment