rendering

Documentation

Index

• Constants
• func NameForFilename(filename string) string
• func NewDeveloperGuide(info InfoProvider) ([]byte, error)
• func NewGraduationCriteria(info InfoProvider) ([]byte, error)
• func NewMotivation(info InfoProvider) ([]byte, error)
• func NewOperatorGuide(info InfoProvider) ([]byte, error)
• func NewReadme(info InfoProvider) ([]byte, error)
• func NewSummary(info InfoProvider) ([]byte, error)
• func NewTeacherGuide(info InfoProvider) ([]byte, error)
• type InfoProvider
• type SectionProvider

Constants

const (
	DeveloperGuideName     = "Developer Guide"
	DeveloperGuideFilename = "guides/developer.md"
)

const (
	GraduationCriteriaName     = "Graduation Criteria"
	GraduationCriteriaFilename = "graduation_criteria.md"
)

const (
	MotivationName     = "Motivation"
	MotivationFilename = "motivation.md"
)

const (
	OperatorGuideName     = "Operator Guide"
	OperatorGuideFilename = "guides/operator.md"
)

const (
	ReadmeName     = "README"
	ReadmeFilename = "README.md"
)

const (
	SummaryName     = "Summary"
	SummaryFilename = "summary.md"
)

const (
	TeacherGuideName     = "Teacher Guide"
	TeacherGuideFilename = "guides/teacher.md"
)

Functions

func NameForFilename

func NameForFilename(filename string) string

TODO move after all tests green

func NewDeveloperGuide

func NewDeveloperGuide(info InfoProvider) ([]byte, error)

func NewGraduationCriteria

func NewGraduationCriteria(info InfoProvider) ([]byte, error)

func NewMotivation

func NewMotivation(info InfoProvider) ([]byte, error)

func NewOperatorGuide

func NewOperatorGuide(info InfoProvider) ([]byte, error)

func NewReadme

func NewReadme(info InfoProvider) ([]byte, error)

func NewSummary

func NewSummary(info InfoProvider) ([]byte, error)

func NewTeacherGuide

func NewTeacherGuide(info InfoProvider) ([]byte, error)

Types

type InfoProvider

type InfoProvider interface {
	Title() string
	Authors() []string
	OwningSIG() string
	State() states.Name
	ContentDir() string
	LastUpdated() time.Time
	SectionLocations() []string
}

type SectionProvider

type SectionProvider interface {
	Name() string
	Filename() string
	Content() []byte
}

TODO delete this interface if unused