docs

Documentation

Index

• Variables
• func ReleaseNotesURL(pageName string) string
• func URL(pageName string) string

Variables

var URLBase = "https://www.cockroachlabs.com/docs/" + build.BinaryVersionPrefix()

URLBase is the root URL for the version of the docs associated with this binary.

var URLReleaseNotesBase = fmt.Sprintf("https://www.cockroachlabs.com/docs/releases/%s.0.html",
	build.BinaryVersionPrefix())

URLReleaseNotesBase is the root URL for the release notes for the .0 patch release associated with this binary.

Functions

func ReleaseNotesURL

func ReleaseNotesURL(pageName string) string

ReleaseNotesURL generates the URL to pageName in the .0 patch release notes docs associated with this binary.

func URL

func URL(pageName string) string

URL generates the URL to pageName in the version of the docs associated with this binary.