style

Documentation

Index

• func Code(s any) string
• func DiagnosticGroup(s any) string
• func DiagnosticHeader(s any) string
• func DiagnosticLabel(s any) string
• func DiffAfter(s any) string
• func DiffBefore(s any) string
• func InSyncRelease(s any) string
• func InSyncReleaseVersion(s any) string
• func Link(s any) string
• func OK(s any) string
• func OutOfSyncRelease(s any) string
• func ReleaseInSync(s any) string
• func ReleaseNotAvailable(s any) string
• func ReleaseOutOfSync(s any) string
• func Resource(s any) string
• func ResourceEnvPrefix(s any) string
• func ResourceKind(s any) string
• func SecondaryInfo(s any) string
• func Version(s any) string
• func Warning(s any) string

Functions

func Code

func Code(s any) string

Code is for code snippets, commands, yaml properties, or any technical text that is not a resource name

func DiagnosticGroup

func DiagnosticGroup(s any) string

DiagnosticGroup is for the header of a diagnostic section

func DiagnosticHeader

func DiagnosticHeader(s any) string

DiagnosticHeader is for the header of a diagnostic

func DiagnosticLabel

func DiagnosticLabel(s any) string

DiagnosticLabel is for the label of a diagnostic item

func DiffAfter

func DiffAfter(s any) string

DiffAfter is for text that is being added in a diff

func DiffBefore

func DiffBefore(s any) string

DiffBefore is for text that is being removed in a diff

func InSyncRelease

func InSyncRelease(s any) string

func InSyncReleaseVersion

func InSyncReleaseVersion(s any) string

func Link

func Link(s any) string

Link is for URLs and other links

func OK

func OK(s any) string

OK is for items that are in expected state, such as a release that is in sync with other environments

func OutOfSyncRelease

func OutOfSyncRelease(s any) string

func ReleaseInSync

func ReleaseInSync(s any) string

ReleaseInSync is for releases that are in sync across environments

func ReleaseNotAvailable

func ReleaseNotAvailable(s any) string

ReleaseNotAvailable is for releases that are not existing in an environment or have not version specified

func ReleaseOutOfSync

func ReleaseOutOfSync(s any) string

ReleaseOutOfSync is for releases that are not in sync across environments

func Resource

func Resource(s any) string

Resource is for the name of resources and entities such as releases, projects, environments, clusters, etc.

func ResourceEnvPrefix

func ResourceEnvPrefix(s any) string

ResourceEnvPrefix is for the environment prefix in front of a resource name (eg: `staging` in `staging/<release-name>`)

func ResourceKind

func ResourceKind(s any) string

ResourceKind is for a kind of resource (eg: `Release`, `Project`, `Environment`)

func SecondaryInfo

func SecondaryInfo(s any) string

SecondaryInfo is for text that should be less prominent than the main text

func Version

func Version(s any) string

Version is for release versions within messages (not tables)

func Warning

func Warning(s any) string

Warning is for text that is a warning or an error, such as a missing/unsynched release or an uncommitted change