Terraform-provider-kubernetes: Broken links in docs

Created on 5 Sep 2020 · 6Comments · Source: hashicorp/terraform-provider-kubernetes

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

bug documentation help wanted

Source

dak1n1

👍1

All 6 comments

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

neha-viswanathan on 9 Oct 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!

dak1n1 on 16 Oct 2020

👍1

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

neha-viswanathan on 18 Oct 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. https://github.com/hashicorp/terraform-provider-kubernetes/pull/1027 But after it's merged, you're welcome to fix as many links as you like! :smile:

dak1n1 on 19 Oct 2020

❤1

@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)

dak1n1 on 18 Nov 2020

🎉1

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.