search

nozaq / terraform-aws-secure-baseline

Terraform module to set up your AWS account with the secure baseline configuration based on CIS Amazon Web Services Foundations and AWS Foundational Security Best Practices.
MIT License
1.14k stars 372 forks source link

Example links on https://registry.terraform.io/modules/nozaq/secure-baseline/aws/2.0.0 are dead #298

Closed WTPascoe closed 1 year ago

WTPascoe commented 2 years ago

Describe the bug

The example links within the text at https://registry.terraform.io/modules/nozaq/secure-baseline/aws/2.0.0 return 404 errors when clicking them:

Versions

Reproduction

Visit any of the following links or click them from within the page at https://registry.terraform.io/modules/nozaq/secure-baseline/aws/2.0.0

Expected behavior

Example documentation is returned

Actual behavior

An error stating '404 Not Found' is returned in the browser

nozaq commented 2 years ago

@WTPascoe Thank you for reporting the issue. README.md contains relative links which were assumed be rendered on GitHub. Thus when rendered on Terraform Registry, these links were broken due to the wrong base URL. I found that someone reported this issue in terraform registry, but it's still open. https://github.com/hashicorp/terraform/issues/21452

I tried to replace relative links with absolute ones, but it requires to put https://github.com/path/to/repo/tree/main prefix on every links. This could be problematic since the fixed branch(main in the example above) needs to be explicitly specified in addition to the verbosity. I will keep this open until we'll find a good workaround, or the issue is resolved on Terraform Registry side.