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

Jump to bottom

scratch: add doc.go #27427

Closed
kevinburke opened this issue Aug 31, 2018 · 2 comments
Closed

scratch: add doc.go #27427

kevinburke opened this issue Aug 31, 2018 · 2 comments
Labels
FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Milestone
Unreleased

Comments

@kevinburke
Copy link
Contributor

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.
@andybons andybons added help wanted NeedsFix The path to resolution is known, but the work has not been done. labels Sep 4, 2018
@andybons andybons added this to the Unreleased milestone Sep 4, 2018
@leighmcculloch leighmcculloch mentioned this issue Sep 9, 2018
Closed
@gopherbot
Copy link

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

@dmitshur
Copy link
Contributor

dmitshur commented Sep 9, 2018 •
edited

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.

@golang golang locked and limited conversation to collaborators Sep 21, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
FrozenDueToAge help wanted NeedsFix The path to resolution is known, but the work has not been done.
Projects
None yet
Milestone
Unreleased
Development

No branches or pull requests
4 participants
@kevinburke @andybons @dmitshur @gopherbot