go.olly.garden

Vanity URL service for Go modules in the OllyGarden organization.

Overview

This repository provides custom import paths for Go modules under the go.olly.garden domain. It serves HTML pages with go-import meta tags that redirect the Go toolchain to the actual source repositories on GitHub.

Available Modules

The following modules are available under go.olly.garden:

Usage

Import any module using its vanity URL:

import "go.olly.garden/trellis"

Local Development

For local development with private repositories, see DEVELOPMENT.md for setup instructions.

Adding New Modules

To add a new module redirect:

  1. Create a new directory with the module name
  2. Add an index.html file with the appropriate meta tags:
<!DOCTYPE html>
<html>
  <head>
    <meta name="go-import" content="go.olly.garden/MODULE_NAME git https://github.com/ollygarden/MODULE_NAME">
    <meta http-equiv="refresh" content="0; url=https://pkg.go.dev/go.olly.garden/MODULE_NAME">
  </head>
  <body>
    Nothing to see here. Please refer to <a href="https://pkg.go.dev/go.olly.garden/MODULE_NAME">pkg.go.dev</a>.
  </body>
</html>
  1. Replace MODULE_NAME with your actual module name
  2. Commit and deploy the changes

Documentation

Each module’s documentation is automatically available at:

Contributing

This repository is private even though the generated vanity site is public. OllyGarden employees and approved collaborators should follow CONTRIBUTING.md and the repository-specific guidance in AGENTS.md. Update the module inventory above whenever a vanity page is added or removed.

License

This repository is licensed under the Apache License 2.0.