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

Broken links in docs #990

Closed
dak1n1 opened this issue Sep 4, 2020 · 6 comments · Fixed by #1041
Closed

Broken links in docs #990

dak1n1 opened this issue Sep 4, 2020 · 6 comments · Fixed by #1041

Comments

@dak1n1
Copy link
Contributor

dak1n1 commented Sep 4, 2020

There are many broken links in the ./website directory. https://gist.githubusercontent.com/dak1n1/e71930a082cbaaef4137a5cc8749697a/raw/7b3ca8a6311c5419ee905fa07bb83620c42a9bc8/gistfile1.txt

Once those are fixed, the links check can be enabled. (See makefile).

Community Note

  • Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
  • If you are interested in working on this issue or have submitted a pull request, please leave a comment
@neha-viswanathan
Copy link
Contributor

@dak1n1 I'd like to work on this issue.

@dak1n1
Copy link
Contributor Author

dak1n1 commented Oct 16, 2020

@neha-viswanathan That's great! Thanks for offering. The list above is probably still accurate, but here is a command that optionally could be used to get the current list of broken links, in case anything has changed:

https://github.com/hashicorp/terraform-provider-kubernetes/blob/master/GNUmakefile#L129

You could uncomment that line and run make website-lint to run the link check, if you wanted. Either way is ok. Thanks!

@neha-viswanathan
Copy link
Contributor

@dak1n1 Hello Stef, There are several references of these links in the go code as well. Should I fix them too?

@dak1n1
Copy link
Contributor Author

dak1n1 commented Oct 19, 2020

@neha-viswanathan For the Go code, you might want to wait until this PR is merged. It touches most of the .go files since it's an SDK upgrade, which would mean potential merge conflicts. #1027 But after it's merged, you're welcome to fix as many links as you like! 😄

@dak1n1
Copy link
Contributor Author

dak1n1 commented Nov 18, 2020

@neha-viswanathan Thanks for the PR! I just placed this issue into our queue so the next person on bug-duty can review it. (CC @jrhouston FYI)

@github-actions
Copy link

github-actions bot commented Jun 5, 2021

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues.
If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 5, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants