Skip to content

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.

Sign up for GitHub

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

docs: Fix broken link for terraform install #2141

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b77b4a7
docs: Fix broken link for terraform install
askulkarni2 Sep 15, 2025
56e1993
Update getting-started.md
askulkarni2 Sep 15, 2025
4663c9a
ignore broken link check
askulkarni2 Sep 15, 2025
1051e6d
Apply suggestion from @rodrigobersa
askulkarni2 Sep 16, 2025
bf7984b
Update linkcheck.json
askulkarni2 Sep 16, 2025
f7a52ad
Update .github/workflows/linkcheck.json
csantanapr Sep 19, 2025
c7da8ed
add link to ignore to avoid 429 errors even with retries
csantanapr Sep 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/linkcheck.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@
"pattern": [
"127.0.0.1"
]
},
{
"pattern": "https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli"
Copy link
Contributor

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

Copy link
Contributor

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 ?

Copy link
Contributor

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

Copy link
Contributor

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

}
]
}
2 changes: 1 addition & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Ensure that you have installed the following tools locally:

- [awscli](https://docs.aws.amazon.com/cli/latest/userguide/install-cliv2.html)
- [kubectl](https://Kubernetes.io/docs/tasks/tools/)
- [terraform](https://learn.hashicorp.com/tutorials/terraform/install-cli)
- [terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli)

## Deploy

Expand Down
Loading