-
Notifications
You must be signed in to change notification settings - Fork 487
DOCS: Fix incorrect hetzner links #3988
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
DOCS: Fix incorrect hetzner links #3988
Conversation
|
Good catch! We renamed some files/directories and missed those links. Thanks for the PR! |
|
@tlimoncelli the page hasn't updated yet, did I change the wrong/right place? there are others which aren't hetzner which are also broken, should I PR those as well? |
|
@cafferata can you please advise? |
Sure! I see you (@tlimoncelli) reverted theses changes in 7db2055 🤓 |
|
Oh I forget thats a generated file so this was a relatively pointless PR 😅 Do the files have to contain underscores to match the name of the provider? |
@willpower232 I am not sure. I can see that @chicks-net introduced a refactor in #3909 which appears to cause this behavior. @chicks-net would you be willing to take a look at this bug? https://docs.dnscontrol.org/provider/index#:~:text=HETZNER_V2 |
|
I will look into it this weekend. Traveling today. |
|
Ok, I think I see what is going on here. The generated docs include an underscore, but the documentation filename no longer has an underscore in it. The same issue is happening with azure/bunny/gandi which had underscores in the filenames before #3909 . So this is definitely my fault. Trying to fix in #4041 . P.S. gitbook is still trying to torment me, but I'm trying to come up with some linting that would catch these issues before they're user-facing. Until then.. 😂 |
# context #3909 introduced a bug in the feature table matrix. Provider docs had underscores removed, but the generated table still included the underscores. This was brought to my attention in <#3988 (comment)>. It was apparent that the issue effected all providers that had underscores. # changes Fix generator to remove underscores from those providers. The user display will still include the underscores, but the links should work again. # verify once the PR GHAs run.... - provider table links are working again! 🎉 # question Is there a cleaner way to fix this? This seems pretty good to me, but I always wonder.
I went to look at the Hetzner V2 documentation and found they were based on an external link which wasn't working. I think this is the fix but I might be wrong.
Also I don't think any of the external links are working on the providers index page https://docs.dnscontrol.org/provider/index
I wonder if these are all dead links which create external links when the site is compiled?