docs

package
v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 18, 2024 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	DocumentationMarkdownHeader  = "# Policy Justification\n\nThis file contains justification for access policies needed by this project.\n\n"
	DocumentationFilePermissions = 0600
)
View Source 
const (
	HeaderEffect     = "effect"
	HeaderPermission = "permission"
	HeaderResource   = "resource"
	HeaderReason     = "reason"
)

Variables

View Source 
var (
	ErrMissingFilename = errors.New("missing documentation file name")
)

Functions 

func Header() []string

Header defines the table Header for our documentation page. This is ordered, so be aware that changing the order will affect the display.

Types

type Documentation 

type Documentation struct {
	File *files.File
}

func NewDocumentation 

func NewDocumentation(file *files.File) *Documentation

func (*Documentation) Generate added in v0.0.2 

func (docs *Documentation) Generate(rows ...Row)

Generate generates a document from a set of rows.

type Row 

type Row interface {
	EffectColumn() string
	PermissionColumn() string
	ResourceColumn() string
	ReasonColumn() string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.