hashicorp / terraform-provider-azurerm

Terraform provider for Azure Resource Manager
https://registry.terraform.io/providers/hashicorp/azurerm/latest/docs
Mozilla Public License 2.0
4.61k stars 4.65k forks source link

MIsalignment of resource names and website articles #26880

Open ascheman opened 3 months ago

ascheman commented 3 months ago

Is there an existing issue for this?

Community Note

Terraform Version

1.5.7

AzureRM Provider Version

3.113.0

Affected Resource(s)/Data Source(s)

misc. (see below)

Terraform Configuration Files

Several resources have a different name than the respective html.markdown file, for example, the ressource "azurerm_healthbot" is described in a file [bot_healthbot.html.markdown](https://github.com/hashicorp/terraform-provider-azurerm/blob/569c7581033651de55ed3bdfd1fb6f8110713c2c/website/docs/r/bot_healthbot.html.markdown).
It would be great, if the files could follow a clear naming convention in order to automatically derive the respective documentation page for a resource by its name.

The same holds true (as of today) for the following resources, datasources were not checked:
azurerm_mysql_flexible_server_active_directory_administrator
azurerm_palo_alto_next_generation_firewall_virtual_hub_panorama
azurerm_datadog_monitor
azurerm_signalr_shared_private_link_resource
azurerm_palo_alto_virtual_network_appliance
azurerm_api_management_global_schema
azurerm_web_pubsub_shared_private_link_resource
azurerm_fluid_relay_server
azurerm_sentinel_alert_rule_machine_learning_behavior_analytics
azurerm_marketplace_role_assignment
azurerm_media_live_event_output
azurerm_dev_center_catalog
azurerm_data_factory_credential_user_managed_identity
azurerm_managed_disk_sas_token
azurerm_data_factory_trigger_tumbling_window
azurerm_healthcare_dicom_service
azurerm_restore_point_collection
azurerm_palo_alto_next_generation_firewall_virtual_hub_local_rulestack
azurerm_healthbot
azurerm_security_center_server_vulnerability_assessment

Debug Output/Panic Output

None

Expected Behaviour

markdown pages are named after the respective resources

Actual Behaviour

some pages do have different names (see above)

Steps to Reproduce

Drop "azurerm_" from the resource name (leaving xxx) and try to find respective website/r/xxx.html.markdown file.

Important Factoids

No response

References

No response

wuxu92 commented 3 months ago

I believe the file name bot_healthbot is intended to group all bot-related documents together when sorted alphabetically.

image