Fixed relative links to example and tests #589
Conversation
| elif link.startswith('/'): | ||
| updated_link = updated_link.replace('/', '', 1) |
There was a problem hiding this comment.
This feels wrong. We're taking an absolute path and making it relative. Did you see any examples of where this would be required?
There was a problem hiding this comment.
actually it is the other way around. We are taking relative link and replacing them with absolute path links to github:
So this examples/complete gets replaced with https://github.com/cloudposse/terraform-aws-elastic-beanstalk-environment/tree/main/examples/complete
Complete log or what gets replaced with what can be seen here: https://gist.github.com/zdmytriv/3e42f497539b16a786710e01e067fbd7
There was a problem hiding this comment.
ok i got what you mean. There are two modules that have full path.
We can't have absolute paths neither on GitHub nor in docs. Github renders README.html from README.md by making absolute path as relative path to root folder of the repo. This is what we do as well in docs.
I think it is fine to have it like this because we will never run into link that will have absolute path like '/cloudposse/terrraform-aws-sso/...' in README.md.
9b83f15
to
b78e846
Compare
what
why
references