Starting point

[HelloGrayson]

I whipped up this quick and dirty MVP today. It's powering the Go package breerly.github.io/test/ptr at the moment, which is being hosted via Github Pages via this repo: https://github.com/breerly/test

How it works

Given the following sally.yaml:

---

url: breerly.github.io/test

packages:
  ptr:
    repo: github.com/breerly/ptr

The site is generated using sally and the html files are committed to the repo:

$ go install github.com/uber-go/sally
$ sally -dir .
$ git commit -am "site generated"

Pushing the repo results in the static site being updated:

$ git push
$ wget breerly.github.io/test/ptr

This enables the package to be installed using the canonical path:

$ go get breerly.github.io/ptr

I intend to do the following before OSS'ing this repo:

• Get go.uber.org in a state where we're happy
• Clean up and write tests
• Write a guide for using sally

[HelloGrayson]

cc @prashantv @abhinav

[HelloGrayson]

Worth noting that the source declares the canonical import path here: https://github.com/breerly/ptr/blob/master/ptr.go#L22

package ptr // import "breerly.github.io/test/ptr"

This forces the user to use the canonical path by raising an error if installed directly:

$ go get github.com/breerly/ptr
can't load package: package github.com/breerly/ptr: code in directory $GOPATH/src/github.com/breerly/ptr expects import "breerly.github.io/test/ptr"

[abhinav]

inline