docsgen

Documentation

Index

• Constants
• func Execute(opts Options) error
• type ChangelogConfig
• type ChangelogOptions
• type CliOptions
• type IndexEntry
• type Options
• type PackageIndex
• type ProtoOptions

Constants

const (
	GithubOrg                  = "solo-io"
	GlooMeshEnterpriseRepoName = "gloo-mesh-enterprise"
	GlooMeshRepoName           = "gloo-mesh"
)

Functions

func Execute

func Execute(opts Options) error

Types

type ChangelogConfig

type ChangelogConfig struct {
	Name  string
	Repo  string
	Fname string
}

type ChangelogOptions

type ChangelogOptions struct {
	OutputDir  string
	OtherRepos []ChangelogConfig
}

type CliOptions

type CliOptions struct {
	RootCmd   *cobra.Command
	OutputDir string
}

type IndexEntry

type IndexEntry struct {
	Name string
	Link string
}

type Options

type Options struct {
	Proto     ProtoOptions
	Cli       CliOptions
	Changelog ChangelogOptions
	DocsRoot  string // Will default to docs if empty
}

type PackageIndex

type PackageIndex struct {
	// maps CRD name to CrdIndex
	Crds     map[string]*IndexEntry
	Services []*IndexEntry
}

type ProtoOptions

type ProtoOptions struct {
	ProtoRoot string // Will default to vendor_any if empty
	OutputDir string
}