fix: #177 use rendered provider name in default template

[Fuochi]

This is to solve #177 as suggested here: #177 (comment)

If --rendered-provider-name is set, the default template will use it. If not, it will continue to use previous value

[hashicorp-cla]

All committers have signed the CLA.

[jacobbednarz]

i believe the logic is incorrect here as this will always attempt to use .RenderedProviderName since .ProviderName is always going to differ from .RenderedProviderName.

i think what want is more like this:

{- $name := .ProviderShortName}}
{{- if .RenderedProviderName }}{{ $name = .RenderedProviderName }}{{ end }}
page_title: "{{ $name }} Provider"

(this is also more explicit by checking if the rendered provider name value is set, not just different)

[Fuochi]

I think .RenderedProviderName is always set, and its default value is .ProviderName. Here's the reference:

terraform-plugin-docs/internal/provider/generate.go

Lines 123 to 125 in 2f535d3

	if g.renderedProviderName == "" {
	g.renderedProviderName = providerName
	}

Feel free to try it out!

[Fuochi]

@jacobbednarz have you had the chance to check again?

[jacobbednarz]

i haven't, however, being explicit in the template makes this clear what the expected outcome is instead of relying on overrides within the generation process.

[Fuochi]

I totally agree! Actually, the solution you proposed was the first one that came to my mind as well. Unfortunately, it just doesn't work because the .RenderedProviderName is never unset, as shown in the previous comment.
Thus, this PR will keep the default behaviour the same as it was before, and it overrides the provider name in the template only if the specific variable has been set.

[stevehipwell]

👀

[SBGoods]

Hi @Fuochi 👋🏾,
We've decided to take a different approach to solving this issue in #492, so I will be closing this PR.

[Fuochi]

Hi @SBGoods. No problem, happy to see that finally this has been addressed and this repo is still maintained by someone!