Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func WritePage ¶
func WritePage(crd apiextensionsv1.CustomResourceDefinition, crdAnnotations []annotations.CRDAnnotationSupport, md config.CRDItem, examplesCRs map[string]string, outputFolder, repoURL, repoRef, templatePath string) (string, error)
WritePage creates a CRD schema documentation Markdown page.
Types ¶
type PageData ¶
type PageData struct { Description string Metadata config.CRDItem Group string NamePlural string NameSingular string Scope string SourceRepository string SourceRepositoryRef string Title string Weight int // Version names. Versions []string // Schema per version. VersionSchemas map[string]SchemaVersion }
PageData is all the data we pass to the HTML template for the CRD detail page.
type SchemaVersion ¶
type SchemaVersion struct { Version string Properties []jsonschema.Property // YAML string showing an example CR. ExampleCR string Annotations []annotations.CRDAnnotationSupport }
SchemaVersion is the schema information for a specific CRD version we want to expose to our template.
Click to show internal directories.
Click to hide internal directories.