diff --git a/.changes/unreleased/BREAKING CHANGES-20230606-092955.yaml b/.changes/unreleased/BREAKING CHANGES-20230606-092955.yaml new file mode 100644 index 00000000..cd09d3b2 --- /dev/null +++ b/.changes/unreleased/BREAKING CHANGES-20230606-092955.yaml @@ -0,0 +1,6 @@ +kind: BREAKING CHANGES +body: 'generate: The `legacy-sidebar` flag has been removed without replacement. It + implemented no logic and is not necessary with Terraform Registry based documentation' +time: 2023-06-06T09:29:55.309657-04:00 +custom: + Issue: "258" diff --git a/README.md b/README.md index 114d2260..97f16ae9 100644 --- a/README.md +++ b/README.md @@ -41,7 +41,6 @@ Usage: tfplugindocs generate [] --examples-dir examples directory (default: "examples") --ignore-deprecated don't generate documentation for deprecated resources and data-sources (default: "false") - --legacy-sidebar generate the legacy .erb sidebar file (default: "false") --provider-name provider name, as used in Terraform configurations --rendered-provider-name provider name, as generated in documentation (ex. page titles, ...) --rendered-website-dir output directory (default: "docs") diff --git a/internal/cmd/generate.go b/internal/cmd/generate.go index 14275961..3bd3468d 100644 --- a/internal/cmd/generate.go +++ b/internal/cmd/generate.go @@ -14,7 +14,6 @@ import ( type generateCmd struct { commonCmd - flagLegacySidebar bool flagIgnoreDeprecated bool flagProviderName string @@ -71,7 +70,6 @@ func (cmd *generateCmd) Help() string { func (cmd *generateCmd) Flags() *flag.FlagSet { fs := flag.NewFlagSet("generate", flag.ExitOnError) - fs.BoolVar(&cmd.flagLegacySidebar, "legacy-sidebar", false, "generate the legacy .erb sidebar file") fs.StringVar(&cmd.flagProviderName, "provider-name", "", "provider name, as used in Terraform configurations") fs.StringVar(&cmd.flagRenderedProviderName, "rendered-provider-name", "", "provider name, as generated in documentation (ex. page titles, ...)") fs.StringVar(&cmd.flagRenderedWebsiteDir, "rendered-website-dir", "docs", "output directory") @@ -97,7 +95,6 @@ func (cmd *generateCmd) Run(args []string) int { func (cmd *generateCmd) runInternal() error { err := provider.Generate( cmd.ui, - cmd.flagLegacySidebar, cmd.flagProviderName, cmd.flagRenderedProviderName, cmd.flagRenderedWebsiteDir, diff --git a/internal/provider/generate.go b/internal/provider/generate.go index 46f76664..388368b6 100644 --- a/internal/provider/generate.go +++ b/internal/provider/generate.go @@ -67,7 +67,6 @@ var ( type generator struct { ignoreDeprecated bool - legacySidebar bool tfVersion string providerName string @@ -88,10 +87,9 @@ func (g *generator) warnf(format string, a ...interface{}) { g.ui.Warn(fmt.Sprintf(format, a...)) } -func Generate(ui cli.Ui, legacySidebar bool, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, websiteSourceDir, tfVersion string, ignoreDeprecated bool) error { +func Generate(ui cli.Ui, providerName, renderedProviderName, renderedWebsiteDir, examplesDir, websiteTmpDir, websiteSourceDir, tfVersion string, ignoreDeprecated bool) error { g := &generator{ ignoreDeprecated: ignoreDeprecated, - legacySidebar: legacySidebar, tfVersion: tfVersion, providerName: providerName, @@ -185,12 +183,6 @@ func (g *generator) Generate(ctx context.Context) error { return err } - // TODO: may not ever need this, unsure on when this will go live - if g.legacySidebar { - g.infof("rendering legacy sidebar...") - g.warnf("TODO...!") - } - return nil }