docsgen

package
v1.1.2 Latest Latest
Warning

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

Go to latest
Published: Sep 29, 2021 License: Apache-2.0 Imports: 31 Imported by: 0

Documentation

Index

Constants

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

Variables

This section is empty.

Functions

func Execute

func Execute(opts Options) error

Types

type ChangelogConfig added in v0.10.3

type ChangelogConfig struct {
	Name  string
	Repo  string
	Fname string
}

type ChangelogOptions added in v0.10.3

type ChangelogOptions struct {
	OutputDir  string
	OtherRepos []ChangelogConfig
}

type CliOptions

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

type IndexEntry added in v0.12.0

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 added in v0.12.0

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
}

Jump to

Keyboard shortcuts

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