docs

Documentation

Index

• func DocumentationUrl(opts DocOptions) string
• func ProviderDocumentationRootUrl() string
• func ProviderRegistryUrl() string
• type DocOptions
• type Section

Functions

func DocumentationUrl

func DocumentationUrl(opts DocOptions) string

DocumentationUrl is the URL for a specific guide in the provider documentation. See the documentation for DocOptions for more information.

func ProviderDocumentationRootUrl

func ProviderDocumentationRootUrl() string

ProviderDocumentationRootUrl is the URL of the documentation for the Terraform provider for Databricks.

func ProviderRegistryUrl

func ProviderRegistryUrl() string

ProviderRegistryUrl is the URL of the registry page for the Terraform provider for Databricks.

Types

type DocOptions

type DocOptions struct {
	// Section is the section of the doc that should be linked to.
	Section Section

	// Slug is the URI slug for the page. This should be the name of the markdown file containing the documentation
	// for the resource, data source, or guide, not including the `.md` extension.
	Slug string

	// Fragment is an optional fragment to link to in the documentation page. If unspecified, the link will
	// refer to the page itself.
	Fragment string
}

DocOptions describes a single documentation reference for the provider in the Terraform registry. At a minimum, the Slug fields must be specified. If unspecified, the default section is Resources. If desired, a fragment can be provided to link to a specific anchor in the documentation page.

type Section

type Section int

Section is the section of the documentation for the provider in the Terraform registry.

const (
	// Resources is the section containing documentation for an individual resource.
	Resources Section = iota

	// DataSources is the section containing documentation for an individual data source.
	DataSources

	// Guides is the section containing guides or walkthroughs for customers to get started using the provider.
	Guides
)