[new docs site] relative links on URLs with and without a trailing slash

Environment

main branch, npm start in the docs directory.

What parser are you using?

Default (Espree)

What did you do?

Open USER GUIDE > Rules > no-cond-assign. Then, in the Related Rules section click no-extra-parens link.

What did you expect to happen?

To open no-extra-parens document.

What actually happened?

The link is broken as it points to rules/no-cond-assign/no-extra-parens.

Participation

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

Additional comments

This is caused by writing rules/no-cond-assign.md to rules/no-cond-assign/index.html, unlike the current site where it is rules/no-cond-assign.html. The path on the new site is rules/no-cond-assign/ (with / at the end) as opposed to the current site where it is rules/no-cond-assign (without / at the end) so the relative links in the document are broken.

[mdjermanovic]

link - https://new.eslint.org/docs/user-guide/getting-started/

On the current site, this page is https://eslint.org/docs/user-guide/getting-started (without trailing slash). Relative links on the page were set based on the URL without the trailing slash, and the current site redirects https://eslint.org/docs/user-guide/getting-started/ to https://eslint.org/docs/user-guide/getting-started, so it always works well.

On the new site, redirects don’t work, and with the trailing slash in https://new.eslint.org/docs/user-guide/getting-started/ relative links on the page are broken.

I have created a draft pr #15919. I would like to work on this. Can I find and fix the broken links?

I think we should decide on the approach first. Some ways to address this might be:

1. Make redirects work on new.eslint.org/docs. I believe this would be ideal, but not sure if it is possible with Netlify’s proxying.
2. Disable trailing slash redirects on docs-eslint.netlify.app so that it returns 404 on missing/extra trailing slash, if that’s possible on Netlify.
3. Allow all URLs with and without a trailing slash, but use only domain-relative links (start with /) everywhere. It would probably be good to also decide for each page what would be its canonical URL, and generate rel="canonical" link tags and the sitemap accordingly.

[nzakas]

Ooh, <base> seems like a good idea. Let’s try that: https://github.com/eslint/eslint/pull/16046

Alternate approach:

        if (!/(?:\/|\.html)$/.test(location.href)) {
            history.replaceState({}, "", location.href + "/");
        }