CXF-98497: Fix failing GHA Docs

[d-bhola]

1. Modified GHA jobs by adding scripts for running terraform-docs. My changes include four jobs-

   • Install terraform-docs
   • Render Terraform docs inside the README.md files of examples
   • Render Terraform docs inside the README.md files of modules
   • Replace EXAMPLE_PATH placeholders inside the README.md files of examples

2. Minor changes to examples-terraform-docs.yaml config file

[d-bhola]

Tested these changes. GHA jobs are passing here

[d-bhola]

@thogarty I couldn't find a corresponding attribute (in GHA) to support the last parameter in terraform docs command( "$dir" ) which defines inside which directory the terraform-docs command would run. Therefore, I decided to use this approach of using running a script.

[thogarty]

I support the approach. Still leverages terraform-docs just not directly with their GHA job.

I was wondering why a pull request wasn't created at the the end of the github action that was run from your change? https://github.com/equinix/terraform-equinix-fabric/actions/runs/10322345359/job/28577358771

In the action you ran it should create a PR with the updates that it made during the earlier steps of the GHA workflow job.

[thogarty]

LGTM, thank you @d-bhola !