provider

package

v0.19.1 Latest Latest Go to latest Published: Apr 22, 2024 License: MPL-2.0 Imports: 42 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
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 Logger
- func NewLogger(ui cli.Ui) *Logger

Constants ¶

View Source

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

	DocumentationGlobPattern    = `{docs/index.md,docs/{,cdktf/}{data-sources,guides,resources,functions}/**/*,website/docs/**/*}`
	DocumentationDirGlobPattern = `{docs/{,cdktf/}{data-sources,guides,resources,functions}{,/*},website/docs/**/*}`
)

Variables ¶

View Source

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

View Source

var LegacyGuideFrontMatterOptions = &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) error

Types ¶

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

Source Files ¶

View all Source files

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