Rendered provider name not being picked up

[posriniv]

The latest version of tfplugindocs doesn't use the --rendered-provider-name parameter while generating the documentation.

[jacobbednarz]

can you provide more details on this? we are using the latest version with this flag and it is working as expected.

[posriniv]

@jacobbednarz The value I pass in as --provider-name is being used in the place where --rendered-provider-name must be used. Can you please let me know what other information would help you?

[jacobbednarz]

if you clone https://github.com/cloudflare/terraform-provider-cloudflare and run make docs, it should demonstrate this in use and working.

if you can provide a similar repro, I can take a look for you.

[posriniv]

Our repository is not public yet. However, when I tried it on Cloudflare Terraform provider with a different name, I see that the rendered provider name got updated in the resources docs but it didn't get updated on index.md. Is this the expected behavior?

For example, I changed the rendered provider name to New Cloudflare and ran make docs
Here is the page for docs/resources/access_application.md

---                                                                                                  
page_title: "cloudflare_access_application Resource - New Cloudflare"                                
subcategory: ""                                                                                      
description: |-                                                                                      
  Provides a Cloudflare Access Application resource. Access                                          
  Applications are used to restrict access to a whole application using an                           
  authorisation gateway managed by Cloudflare. 
.
.

And, here is the page for docs/index.md

---                                                                                                  
layout: ""                                                                                           
page_title: "Provider: Cloudflare"                                                                   
description: |-                                                                                      
  The Cloudflare provider provides resources to interact with the Cloudflare API.                    
---  

[jacobbednarz]

It uses a custom template that doesn't use the variable - https://github.com/cloudflare/terraform-provider-cloudflare/blob/master/templates/index.md.tmpl, so, yes.

[posriniv]

@jacobbednarz I see. I didn't create any templates directory and it is not being created when I run generate either. That is the reason why rendered_provider_name is not working for me. Is there a way to automatically generate the templates directory and files? I fail to see it in the docs. Thanks a lot for the help.

[jacobbednarz]

you don't have to have a templates directory unless you want to customise it (like using the rendered provider name instead of the default provider name). out of the box, the default index and resource template don't use it so it is a noop.

see the default templates at internal/provider/template.go.

[posriniv]

@jacobbednarz Thank you very much. Closing the issue.

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.