docs

package

v1.0.17 Latest Latest Go to latest Published: Mar 26, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/getporter/porter

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

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"
)

Variables ¶

This section is empty.

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.

Types ¶

This section is empty.

Source Files ¶

View all Source files

docs.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL