-
-
Notifications
You must be signed in to change notification settings - Fork 26
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
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ok, let's try it out.
9b83f15
to
b78e846
Compare
what
why
references