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 broken links #16066

Closed
wants to merge 1 commit into from
Closed

docs: fix broken links #16066

wants to merge 1 commit into from

Conversation

chalkygames123
Copy link
Contributor

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 slug for the "The .eslintignore File" section of the "Ignoring Code" page was changed at some point. So I've updated the links to it, although I'm not sure if that change was intentional.

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

No.

@eslint-github-bot eslint-github-bot bot added triage An ESLint team member will look at this issue soon documentation Relates to ESLint's documentation labels Jun 28, 2022
@netlify
Copy link

netlify bot commented Jun 28, 2022

Deploy Preview for docs-eslint ready!

Name Link
🔨 Latest commit b1b2c74
🔍 Latest deploy log https://app.netlify.com/sites/docs-eslint/deploys/62bae7e3be84f000086626f8
😎 Deploy Preview https://deploy-preview-16066--docs-eslint.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@mdjermanovic mdjermanovic added evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon labels Jun 28, 2022
@mdjermanovic
Copy link
Member

In the old website, we were using github-slugger and some custom corrections:

https://github.com/eslint/archive-website/blob/7ec843b4e1f40396b85a44f336b7599aa0ebc1a1/_11ty/plugins/markdown-plugins.js#L31-L38

In the new website, I think we're just using markdown-it-anchor's default slugify function. I'm also not sure if this change was intentional, but there are probably more broken anchor links now on the new website, so we should either use the same slugify() function from the old website, or verify all the links and update broken ones. @nzakas ?

@nzakas
Copy link
Member

nzakas commented Jun 29, 2022

I think the different slugger was an oversight. We should be able to just copy that over into the docs site.

@mdjermanovic
Copy link
Member

Closing in favor of the solution from #16067

@chalkygames123 thanks for finding this problem!

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 27, 2022
@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 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation evaluating The team will evaluate this issue to decide whether it meets the criteria for inclusion
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants