server

Documentation

Overview

Package server exposes the HTTP API for the postmortems site.

Index

• func CompanySlug(c string) string
• func LoadPostmortem(dir, filename string) (*postmortems.Postmortem, error)
• func LoadPostmortems(dir string) ([]*postmortems.Postmortem, error)
• func New(opts Options) http.Handler
• type Options
• type PageMeta

Functions

func CompanySlug

func CompanySlug(c string) string

CompanySlug turns a company name into a URL-safe slug for /company/{slug}.

func LoadPostmortem

func LoadPostmortem(dir, filename string) (*postmortems.Postmortem, error)

LoadPostmortem reads a single postmortem from dir.

func LoadPostmortems

func LoadPostmortems(dir string) ([]*postmortems.Postmortem, error)

LoadPostmortems reads every postmortem under dir.

func New

func New(opts Options) http.Handler

New returns the HTTP handler, wrapped with otelhttp (excluding /metrics).

Types

type Options

type Options struct {
	Logger         *zap.SugaredLogger
	MetricsHandler http.Handler
	Dir            string
}

Options configures the HTTP router. MetricsHandler is mounted at /metrics.

type PageMeta

type PageMeta struct {
	Path        string
	Title       string
	Description string
	OGType      string // "website" (default) or "article"
}

PageMeta is the per-page SEO/social metadata layout.html consumes as `.Meta`. Path is site-relative; absURL turns it into a full canonical URL.