Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ComponentSubtype ¶
type ComponentSubtype string
ComponentSubtype holds the possible subtypes of a component (e.g. "operator", "AI connector", "data connector") and implements several helper methods.
func (ComponentSubtype) IndefiniteArticle ¶
func (ct ComponentSubtype) IndefiniteArticle() string
IndefiniteArticle returns the correct indefinite article (in English) for a component subtype, e.g., "an" (operator), "an" (AI connector), "a" (data connector).
type ComponentType ¶
type ComponentType string
ComponentType defines the type of a component (e.g. operator, connector). This will condition how the component definition is parsed and how the documentation is generated.
const ( // ComponentTypeConnector ... ComponentTypeConnector ComponentType = "connector" // ComponentTypeOperator ... ComponentTypeOperator ComponentType = "operator" )
func (ComponentType) HasConnectionConfig ¶
func (ct ComponentType) HasConnectionConfig() bool
HasConnectionConfig determines whether a component type requires the creation of a component resource before making it available in pipelines.
type READMEGenerator ¶
type READMEGenerator struct {
// contains filtered or unexported fields
}
READMEGenerator is used to generate the README file of a component.
func NewREADMEGenerator ¶
func NewREADMEGenerator(configDir, outputFile string, componentType ComponentType) *READMEGenerator
NewREADMEGenerator returns an initialized generator.
func (*READMEGenerator) Generate ¶
func (g *READMEGenerator) Generate() error
Generate creates a MDX file with the component documentation from the component schema.
Source Files