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

chore: fix relative link #15544

Merged
merged 1 commit into from Jan 27, 2022
Merged

chore: fix relative link #15544

merged 1 commit into from Jan 27, 2022

Conversation

nschonni
Copy link
Contributor

@nschonni nschonni commented Jan 26, 2022

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

The relative link was missing the .MD extension so it wasn't working in the GitHub UI. The extension is included in the other links to that page in the doc

Is there anything you'd like reviewers to focus on?

@eslint-github-bot eslint-github-bot bot added triage chore labels Jan 26, 2022
@nzakas
Copy link
Member

@nzakas nzakas commented Jan 26, 2022

Thanks. The docs aren’t meant to be read through GitHub — they are copied to the website and so we need the links to work primarily there. In this case, the link will go to https://eslint.org/docs/developer-guide/working-with-rules, which is correct on the website, so I don’t think we want to change it here.

@nschonni
Copy link
Contributor Author

@nschonni nschonni commented Jan 26, 2022

Fair enough, it is used in this style on the page already in a few places https://github.com/eslint/eslint/blame/8e36f21343e3cb9bc4b496387fee2eb397412602/docs/developer-guide/nodejs-api.md#L465 since GitHub pages will just rewrite them anyway

Just noticed it one the failing CI from a proposed new rule in DavidAnson/markdownlint#495

@nzakas
Copy link
Member

@nzakas nzakas commented Jan 27, 2022

Huh. I just checked and it looks like the links are being transformed at some point. So guess this will work. Thanks!

nzakas
nzakas approved these changes Jan 27, 2022
@nzakas nzakas merged commit 5769cc2 into eslint:main Jan 27, 2022
14 checks passed
@nschonni nschonni deleted the patch-1 branch Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore triage
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants