docs(azure-redis-cache): update docs and added examples

[pablosanchezpaz]

No description provided.

[pablosanchezpaz]

Related to #786

[Copilot]

Pull request overview

Updates Azure Redis Cache module documentation to include a richer overview plus runnable examples, and configures terraform-docs to compose the README from header/footer fragments.

Changes:

• Added docs/header.md and docs/footer.md content used to generate the module README.
• Added a basic example under _examples/basic (Terraform + values YAML).
• Added .terraform-docs.yml and updated README.md to use injected terraform-docs output with custom header/footer.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
modules/azure-redis-cache/docs/header.md	New header content: overview, features, YAML examples, notes, file structure.
modules/azure-redis-cache/docs/footer.md	New footer content: example links + support/resources.
modules/azure-redis-cache/_examples/basic/values.yaml	New basic example values file for the module.
modules/azure-redis-cache/_examples/basic/main.tf	New basic example Terraform configuration using the module.
modules/azure-redis-cache/README.md	Reworked README to include the new narrative sections and appended terraform-docs sections.
modules/azure-redis-cache/.terraform-docs.yml	New terraform-docs config to inject generated content into README with header/footer.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[Copilot]

Typo in the private endpoint name (exmaple). This also makes the example internally inconsistent with custom_network_interface_name. Rename to pv_example_redis-nic for consistency.

Suggested change

	name: "pv_exmaple_redis-nic"
	name: "pv_example_redis-nic"

[Copilot]

These example strings contain Terraform-style interpolations inside a YAML values example, and one reference uses a resource name with hyphens (nc-cruks-storage-account), which is not a valid Terraform identifier. Consider replacing these with clear placeholders (e.g., <primary_connection_string> / <secondary_connection_string>) or with valid, consistent example references that users can copy/paste without syntax errors.

Suggested change

	aof_storage_connection_string_0: "DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.nc-cruks-storage-account.primary_blob_endpoint};AccountName=${azurerm_storage_account.mystorageaccount.name};AccountKey=${azurerm_storage_account.mystorageaccount.primary_access_key}"
	aof_storage_connection_string_1: "DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.mystorageaccount.primary_blob_endpoint};AccountName=${azurerm_storage_account.mystorageaccount.name};AccountKey=${azurerm_storage_account.mystorageaccount.secondary_access_key}"
	aof_storage_connection_string_0: "<primary_connection_string>"
	aof_storage_connection_string_1: "<secondary_connection_string>"

[Copilot]

This note conflicts with the included basic example, which sets redis_configuration while using sku_name: Standard. Either update the note to clarify which settings within redis_configuration are Premium-only (if that’s the intent), or adjust the basic example(s) to match the documented constraint.

Suggested change

	- The `redis_configuration` block is only available for Premium SKUs (`sku_name = "Premium"` and `family = "P"`).
	- The `redis_configuration` block can be used with both Standard and Premium SKUs. However, some settings within `redis_configuration` are only available for Premium SKUs (`sku_name = "Premium"` and `family = "P"`); refer to the Azure Cache for Redis documentation for details.

[Copilot]

The output descriptions regressed to n/a, which makes the README less useful for consumers. Please restore meaningful descriptions (e.g., 'The ID of the private endpoint' / 'The ID of the Redis cache') so users understand what each output represents.

Suggested change

	| <a name="output_private_endpoint_id"></a> [private\_endpoint\_id](#output\_private\_endpoint\_id) | n/a |
	| <a name="output_redis_id"></a> [redis\_id](#output\_redis\_id) | n/a |
	| <a name="output_private_endpoint_id"></a> [private\_endpoint\_id](#output\_private\_endpoint\_id) | The ID of the private endpoint associated with the Redis cache. |
	| <a name="output_redis_id"></a> [redis\_id](#output\_redis\_id) | The ID of the Redis cache instance. |

[Copilot]

An empty version field is ambiguous and can make docs generation less reproducible across environments. Consider pinning/constrainting the intended terraform-docs version (or removing the field if it’s not used by your tooling) to avoid accidental formatting diffs.

Suggested change

version: ""

[Copilot]

The README/header YAML examples are wrapped under a values: key, but the checked-in example at _examples/basic/values.yaml is not. This mismatch may confuse users trying to follow the docs. Recommend either updating the docs to match the actual example file format, or adding a brief note explaining when/why the values: wrapper is required.