provider

package

v0.24.0 Latest Latest Go to latest Published: Oct 13, 2025 License: MPL-2.0 Imports: 43 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hashicorp/terraform-plugin-docs

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func Generate(ui cli.Ui, ...) error
func Migrate(ui cli.Ui, providerDir string, templatesDir string, examplesDir string, ...) error
func TerraformProviderSchemaFromFile(providerName, providersSchemaPath string, l *Logger) (*tfjson.ProviderSchema, error)
func TerraformProviderSchemaFromTerraform(ctx context.Context, providerName, providerDir, tfVersion string, l *Logger) (*tfjson.ProviderSchema, error)
func Validate(ui cli.Ui, providerDir, providerName, providersSchemaPath, tfversion string, ...) error
type ActionTemplateType
type FunctionTemplateType
type Logger
- func NewLogger(ui cli.Ui) *Logger
type ProviderTemplateType
type ResourceTemplateType
type ValidatorOptions

Constants ¶

View Source

const (
	FileExtensionHtmlMarkdown = `.html.markdown`
	FileExtensionHtmlMd       = `.html.md`
	FileExtensionMarkdown     = `.markdown`
	FileExtensionMd           = `.md`

	DocumentationGlobPattern    = `` /* 136-byte string literal not displayed */
	DocumentationDirGlobPattern = `{docs/{,cdktf/}{actions,data-sources,ephemeral-resources,guides,list-resources,resources,functions}{,/*},website/docs/**/*}`
)

Variables ¶

View Source

var LegacyFrontMatterOptions = &check.FrontMatterOptions{
	NoSidebarCurrent:   true,
	RequireDescription: true,
	RequireLayout:      true,
	RequirePageTitle:   true,
}

View Source

var LegacyIndexFrontMatterOptions = &check.FrontMatterOptions{
	NoSidebarCurrent:   true,
	NoSubcategory:      true,
	RequireDescription: true,
	RequireLayout:      true,
	RequirePageTitle:   true,
}

View Source

var RegistryFrontMatterOptions = &check.FrontMatterOptions{
	NoLayout:         true,
	NoSidebarCurrent: true,
}

View Source

var RegistryGuideFrontMatterOptions = &check.FrontMatterOptions{
	NoLayout:         true,
	NoSidebarCurrent: true,
	RequirePageTitle: true,
}

View Source

var RegistryIndexFrontMatterOptions = &check.FrontMatterOptions{
	NoLayout:         true,
	NoSidebarCurrent: true,
	NoSubcategory:    true,
}

View Source

var ValidLegacyFileExtensions = []string{
	FileExtensionHtmlMarkdown,
	FileExtensionHtmlMd,
	FileExtensionMarkdown,
	FileExtensionMd,
}

View Source

var ValidRegistryFileExtensions = []string{
	FileExtensionMd,
}

Functions ¶

func Generate ¶

func Generate(ui cli.Ui, providerDir, providerName, providersSchemaPath, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, templatesDir, tfVersion string, ignoreDeprecated bool) error

func Migrate ¶ added in v0.17.0

func Migrate(ui cli.Ui, providerDir string, templatesDir string, examplesDir string, providerName string) error

func TerraformProviderSchemaFromFile ¶ added in v0.19.0

func TerraformProviderSchemaFromFile(providerName, providersSchemaPath string, l *Logger) (*tfjson.ProviderSchema, error)

func TerraformProviderSchemaFromTerraform ¶ added in v0.19.0

func TerraformProviderSchemaFromTerraform(ctx context.Context, providerName, providerDir, tfVersion string, l *Logger) (*tfjson.ProviderSchema, error)

func Validate ¶

func Validate(ui cli.Ui, providerDir, providerName, providersSchemaPath, tfversion string, opts ValidatorOptions) error

Types ¶

type ActionTemplateType ¶ added in v0.24.0

type ActionTemplateType struct {
	Type        string
	Name        string
	Description string

	HasExample   bool
	HasExamples  bool
	ExampleFile  string
	ExampleFiles []string

	ProviderName      string
	ProviderShortName string

	SchemaMarkdown string

	RenderedProviderName string
}

type FunctionTemplateType ¶ added in v0.24.0

type FunctionTemplateType struct {
	Type        string
	Name        string
	Description string
	Summary     string

	HasExample   bool
	HasExamples  bool
	ExampleFile  string
	ExampleFiles []string

	ProviderName      string
	ProviderShortName string

	FunctionSignatureMarkdown string
	FunctionArgumentsMarkdown string

	HasVariadic                      bool
	FunctionVariadicArgumentMarkdown string

	RenderedProviderName string
}

type Logger ¶ added in v0.19.0

type Logger struct {
	// contains filtered or unexported fields
}

func NewLogger ¶ added in v0.19.0

func NewLogger(ui cli.Ui) *Logger

type ProviderTemplateType ¶ added in v0.24.0

type ProviderTemplateType struct {
	Description string

	HasExample   bool
	HasExamples  bool
	ExampleFile  string
	ExampleFiles []string

	ProviderName      string
	ProviderShortName string
	SchemaMarkdown    string

	RenderedProviderName string
}

type ResourceTemplateType ¶ added in v0.24.0

type ResourceTemplateType struct {
	Type        string
	Name        string
	Description string

	HasExample   bool
	HasExamples  bool
	ExampleFile  string
	ExampleFiles []string

	HasImport  bool
	ImportFile string

	HasImportIDConfig  bool
	ImportIDConfigFile string

	HasImportIdentityConfig  bool
	ImportIdentityConfigFile string
	IdentitySchemaMarkdown   string

	ProviderName      string
	ProviderShortName string

	SchemaMarkdown string

	RenderedProviderName string
}

type ValidatorOptions ¶ added in v0.22.0

type ValidatorOptions struct {
	AllowedGuideSubcategories        string
	AllowedGuideSubcategoriesFile    string
	AllowedResourceSubcategories     string
	AllowedResourceSubcategoriesFile string
}

Source Files ¶

View all Source files

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