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

Docs: fix two broken links #14726

Merged
merged 1 commit into from Jun 20, 2021
Merged

Docs: fix two broken links #14726

merged 1 commit into from Jun 20, 2021

Conversation

chenxsan
Copy link
Contributor

@chenxsan chenxsan commented Jun 19, 2021

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 autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

I just noticed another two links are broken on this page.

Before:

  1. https://eslint.org/docs/developer-guide/working-with-rules#messageIds
  2. https://eslint.org/docs/developer-guide/nodejs-api#Linter

After:

  1. https://eslint.org/docs/developer-guide/working-with-rules#messageids
  2. https://eslint.org/docs/developer-guide/nodejs-api#linter

It seems that the markdown-it-anchor plugin eslint website is using would transform all characters in header into lower case, see https://github.com/valeriangalliat/markdown-it-anchor/blob/master/index.js#L3. Which means every URI fragment used on eslint website has to be in lower case, otherwise links generated will be broken just like the aforementioned ones.

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

Nothing.

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Jun 19, 2021
@eslint-github-bot
Copy link

eslint-github-bot bot commented Jun 19, 2021

Hi @chenxsan!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

  • The commit message tag must be one of the following:

    The Tag is one of the following:

    • Fix - for a bug fix.
    • Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
    • New - implements a new feature.
    • Breaking - for a backwards-incompatible enhancement or feature.
    • Docs - changes to documentation only.
    • Build - changes to build process only.
    • Upgrade - for a dependency upgrade.
    • Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).

    You can use the labels of the issue you are working on to determine the best tag.

  • There should be a space following the initial tag and colon, for example 'New: Message'.

  • The first letter of the tag should be in uppercase

Read more about contributing to ESLint here

@chenxsan chenxsan changed the title docs: fix two broken links Docs: fix two broken links Jun 19, 2021
Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM. Thanks!

@snitin315 snitin315 added accepted There is consensus among the team that this change meets the criteria for inclusion documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Jun 19, 2021
Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM, thanks!

@aladdin-add aladdin-add merged commit aada733 into eslint:master Jun 20, 2021
14 checks passed
@chenxsan chenxsan deleted the patch-1 branch Jun 20, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 18, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Dec 18, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants