README: add a short statement of how Tailscale uses golink#240
Conversation
|
|
||
| ## How Tailscale uses golink | ||
|
|
||
| We use golink inside Tailscale every day by every part of the company. |
There was a problem hiding this comment.
Take it or leave it nit: maybe
| We use golink inside Tailscale every day by every part of the company. | |
| golink is used inside Tailscale every day by every part of the company. |
The current wording feels a little off to me.
There was a problem hiding this comment.
That was actually what I had originally, but I couldn't decide on whether "golink" should be capitalized at the beginning of a sentence, so I changed the wording so I didn't have to decide 😛
There was a problem hiding this comment.
FWIW I kind of preferred the active voice, but YMMV.
There was a problem hiding this comment.
Hmm maybe something like "We use golink internally every day across every part of the company" if we want active voice?
Also remove the experimental badge. The "experimental" part of the linked page doesn't exist anymore, and golink is beyond what we'd consider experimental anyway. Updates #docs Signed-off-by: Will Norris <will@tailscale.com>
| since much of the rest of our onboarding involved visiting various go links. | ||
|
|
||
| Our production environment is pretty plain; we just run it on a pretty vanilla EC2 VM. | ||
| We [backup](#backups) all of our go links once a week from a GitHub Action that stores the snapshot in our internal git monorepo. |
There was a problem hiding this comment.
"back up" is the phrasal verb. "backup" is a noun. 🤓
|
|
||
| Our production environment is pretty plain; we just run it on a pretty vanilla EC2 VM. | ||
| We [backup](#backups) all of our go links once a week from a GitHub Action that stores the snapshot in our internal git monorepo. | ||
| That repo has a wrapper script around `golink -resolve-from-backup` so that anyone with a local copy of the repo can always resolve go links offline. |
There was a problem hiding this comment.
if you fix the above, add a double hyphen here? we try to do that elsewhere in Tailscale docs, as it looks less weird to people than Go's style.
4 participants
Also remove the experimental badge. The "experimental" part of the linked page doesn't exist anymore, and golink is beyond what we'd consider experimental anyway.
Updates #docs