-
Notifications
You must be signed in to change notification settings - Fork 1.5k
docs: Fix broken link for terraform install #2141
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
base: main
Are you sure you want to change the base?
Conversation
.github/workflows/linkcheck.json
Outdated
] | ||
}, | ||
{ | ||
"pattern": "https://developer.hashicorp.com/terraform/tutorials/terraform/install-cli" |
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.
Is this link correct? Just to make sure.
Co-authored-by: Rodrigo Bersa <[email protected]>
] | ||
}, | ||
{ | ||
"pattern": "https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli" |
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.
not sure if its intentional, but adding this here means that if this link 404s in the future, it won't get flagged by the link check
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.
That was my question on this file. This is required to be a not-found link, correct @bryantbiggs ?
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.
I'm saying, I don't think this should be added to the ignored patterns because if this link does die in the future, it won't get flagged by the link checker. I believe we do want the link to be checked and for the CI to error if the link 404s
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 is need it to avoid 429 errors even with retries
Run find docs -name "*.md" | xargs -n 1 markdown-link-check -q -c .github/workflows/linkcheck.json
find docs -name "*.md" | xargs -n 1 markdown-link-check -q -c .github/workflows/linkcheck.json
shell: /usr/bin/bash -e {0}
ERROR: 1 dead links found in docs/getting-started.md !
[✖] https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli → Status: 429
Error: Process completed with exit code 123.
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.
Description
Motivation and Context
How was this change tested?
pre-commit run -a
with this PRAdditional Notes