-
Notifications
You must be signed in to change notification settings - Fork 509
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
Fix links on main doc page #1717
Conversation
Tnx for taking the effort to improve the documentation. Maintaining the links is indeed painful and error prone. I thought that I checked them all when I rewrote the documentation a while ago. I am glad that you found them and reported them. Ideally, I prefer relative links as those can be tested on the local machine (see https://github.com/pinterest/ktlint/blob/master/docs/readme.md). The broken page should refer to https://pinterest.github.io/ktlint/rules/configuration-ktlint/. I would really appreciate if you could contribute by reviewing and fixing the ktlint documentation. |
I've used relative links and fixed some links on other pages as well (on my local branch, not pushed yet), but I see now that the Extensions section often refers to https://pinterest.github.io/ktlint-core/ for the source code. This website redirects to https://www.pinterestcareers.com/ instead of showing source code. Should I change these links to this GitHub repo? |
Yes please do change them as well. They are obviously wrong. |
I have just used the Broken Link Checker Tool on the For now, you can ignore links to |
I accidentally deleted my branch at some point somehow, but I think I've finished the PR now! ^^ All dead links have been resolved, all links have been made relative, I have documented the checks to do before release, and I expanded What do you think? Let me know if you spot anything that's still missing or could be better! |
I forgot to mention, there is still one dead link that I cannot solve on my own. On installation/overview, there is a link to https://ktlint-demo.herokuapp.com/ to try out KtLint online. However, that website doesn't work. |
This is looking awesome. I am very glad and pleased that you improved the documentation. |
This a known problem. See saveourtool/diktat-demo#66 |
Description
The website's front page has a few broken links. They use anchors (e.g.
#editorconfig
), but clicking them doesn't do anything.I tried to fix them by changing them to absolute links. I considered using relative links, but saw that that page also has other absolute links to the documentation itself.
I wasn't sure where to link the
#editorconfig
to, because there are multiple places where EditorConfig is discussed in different ways. In the end I just guessed which one would be more appropriate, but maybe the right answer was to remove the link?Checklist
PS: I just noticed there are also other dead links on the website :/
PPS: In the rule configuration section, there is a link to another rule configuration section, but that page is totally broken. Would you like me to open an issue for that?