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

User Guide has broken links #16072

Closed
1 task done
IncPlusPlus opened this issue Jun 30, 2022 · 4 comments
Closed
1 task done

User Guide has broken links #16072

IncPlusPlus opened this issue Jun 30, 2022 · 4 comments
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
Projects

Comments

@IncPlusPlus
Copy link

ESLint version

v8.18.0

What problem do you want to solve?

On the configuring area of the ESLint docs, the links to other sections are all broken (on the main content of the page, not the navigation sidebar) and bring me to a 404. For example, clicking the Configuration Files directs to the URL https://eslint.org/docs/latest/user-guide/configuration-files when it should be directing to https://eslint.org/docs/latest/user-guide/configuring/configuration-files. It seems that the "/configuring" section of the link is missing.

What do you think is the correct solution?

I looked at the markdown files in eslint/tree/main/docs/src/user-guide/configuring. It seems that the links in index.md do point to the right relative location (besides the missing .md file extension which I assume is something done intentionally and unrelated to this issue) so I'm not too sure what the problem is.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

@IncPlusPlus IncPlusPlus added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Jun 30, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jun 30, 2022
@IncPlusPlus IncPlusPlus changed the title Change Request: (fill in) User Guide has broken links Jun 30, 2022
@harish-sethuraman
Copy link
Member

I think removing the ./ in the ./configuration-files#configuration-file-formats path should fix the issue? Works for me in local. Would you like to send a PR and verify the fix in preview if you have any?

* [Configuration File Formats](./configuration-files#configuration-file-formats)

@mdjermanovic mdjermanovic moved this from Needs Triage to Triaging in Triage Jun 30, 2022
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation and removed enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon core Relates to ESLint's core APIs and features labels Jun 30, 2022
@mdjermanovic
Copy link
Member

This is fixed by #16046, but the latest branch has not been updated yet.

I'll leave this open to doublecheck after tomorrow's release (#16029) which will update the content under https://eslint.org/docs/latest/

@harish-sethuraman
Copy link
Member

This has been fixed in the main as well :) We can close this issue.

@mdjermanovic
Copy link
Member

On the configuring area of the ESLint docs, the links to other sections are all broken (on the main content of the page, not the navigation sidebar) and bring me to a 404

This is fixed now on the website. @IncPlusPlus thanks for reporting the problem!

Triage automation moved this from Triaging to Complete Jul 2, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 30, 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 30, 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
Projects
Archived in project
Triage
Complete
Development

No branches or pull requests

3 participants