docs

Documentation

Index

• Constants
• func Docs()
• func DocsBranchPreview()
• func DocsPreview()
• func DocsPullRequestPreview()

Constants

const (
	LocalOperatorRepositoryEnv = "PORTER_OPERATOR_REPOSITORY"
	PreviewContainer           = "porter-docs"

	// DefaultOperatorSourceDir is the directory where the Porter Operator docs
	// are cloned when LocalOperatorRepositoryEnv was not specified.
	DefaultOperatorSourceDir = "docs/sources/operator"
)

Functions

func Docs

func Docs()

Build the website in preparation for deploying to the production website on Netlify. Uses symlinks so it won't work on Windows. Don't run locally, use DocsPreview instead.

func DocsBranchPreview

func DocsBranchPreview()

Build a branch preview of the website.

func DocsPreview

func DocsPreview()

Preview the website locally using a Docker container.

func DocsPullRequestPreview

func DocsPullRequestPreview()

Build a pull request preview of the website.