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

scratch: add doc.go #27427

Open
kevinburke opened this Issue Aug 31, 2018 · 2 comments

Comments

Projects
None yet
4 participants
@kevinburke
Contributor

kevinburke commented Aug 31, 2018

I set up a custom domain so the scratch repo is "go get" able, and godocs are now browsable: https://godoc.org/goscratch.club

However this now makes clear that we should have a doc.go alongside the README at the top level of that project, even if it's just really basic and points people elsewhere.

@gopherbot

This comment has been minimized.

Show comment
Hide comment
@gopherbot

gopherbot Sep 9, 2018

Change https://golang.org/cl/134222 mentions this issue: doc: add package doc

gopherbot commented Sep 9, 2018

Change https://golang.org/cl/134222 mentions this issue: doc: add package doc

@dmitshur

This comment has been minimized.

Show comment
Hide comment
@dmitshur

dmitshur Sep 9, 2018

Member

I set up a custom domain so the scratch repo is "go get" able, and godocs are now browsable

For posterity, the packages inside the scratch repo were always go gettable at their canonical source:

https://godoc.org/go.googlesource.com/scratch.git

The ".git" suffix is necessary because go.googlesource.com isn't one of the few common code hosting sites that have special syntax. The mechanism is documented at https://golang.org/cmd/go/#hdr-Remote_import_paths, starting at the "For code hosted on other servers" paragraph.

Edit: They're also available via the GitHub mirror repo, e.g., https://godoc.org/github.com/golang/scratch.

Member

dmitshur commented Sep 9, 2018

I set up a custom domain so the scratch repo is "go get" able, and godocs are now browsable

For posterity, the packages inside the scratch repo were always go gettable at their canonical source:

https://godoc.org/go.googlesource.com/scratch.git

The ".git" suffix is necessary because go.googlesource.com isn't one of the few common code hosting sites that have special syntax. The mechanism is documented at https://golang.org/cmd/go/#hdr-Remote_import_paths, starting at the "For code hosted on other servers" paragraph.

Edit: They're also available via the GitHub mirror repo, e.g., https://godoc.org/github.com/golang/scratch.

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