Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tests hyperlink on terraform module website is broken #122

Closed
Konig-Corey opened this issue Jan 26, 2021 · 2 comments
Closed

Tests hyperlink on terraform module website is broken #122

Konig-Corey opened this issue Jan 26, 2021 · 2 comments
Labels
bug 🐛 An issue with the system

Comments

@Konig-Corey
Copy link

Super quick and simple. The "Tests" hyper link (https://registry.terraform.io/modules/cloudposse/cloudfront-s3-cdn/aws/test) is a broken link that is included on the readme for the module in Terraform Registry (registry.terraform.io)

Steps to repo:
1: Goto https://registry.terraform.io/modules/cloudposse/cloudfront-s3-cdn/aws/latest
2: Look for sentence "For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test."
3: Click the hyperlink "test"

@Konig-Corey Konig-Corey added the bug 🐛 An issue with the system label Jan 26, 2021
@Nuru
Copy link
Sponsor Contributor

Nuru commented May 13, 2021

@osterman @aknysh Where is that link supposed to take you? I can't tell if we should fix the link or just delete it.

@nitrocode
Copy link
Member

The issue is that the registry ingests the markdown and has no context of relative path links like examples/complete and test.

For a complete example, see [examples/complete](examples/complete).
For automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS), see [test](test).

This issue is probably across all of the cloudposse repos. IMO, it should be fixed in hashicorp's terraform registry, but we could also turn each link from a relative link

[examples/complete](examples/complete)

to an absolute link...

[examples/complete](https://github.com/cloudposse/terraform-aws-cloudfront-s3-cdn/tree/master/examples/complete)

but might be more trouble than it's worth.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug 🐛 An issue with the system
Projects
None yet
Development

No branches or pull requests

3 participants