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: remove configuring.md #14036

Merged
merged 1 commit into from Jan 30, 2021
Merged

Docs: remove configuring.md #14036

merged 1 commit into from Jan 30, 2021

Conversation

mdjermanovic
Copy link
Member

@mdjermanovic mdjermanovic commented Jan 26, 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:

The actual URL for the Configuring ESLint page is:

Now that we have merged #13837, the new URL should be:

This is a different URL, note / at the end.

The problem is that, if we don't remove configuring.html, Netlify redirects https://eslint.org/docs/user-guide/configuring/ to https://eslint.org/docs/user-guide/configuring and serves the content of configuring.html.

What changes did you make? (Give an overview)

Removed configuring.md so that we don't have configuring.html on the website.

With this change, Netlify will also be redirecting all old https://eslint.org/docs/user-guide/configuring links to https://eslint.org/docs/user-guide/configuring/, as in this preview: eslint/archive-website#824

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

  • We have some internal links from some other documents to particular sections in the old configuration page (e.g. the "Specifying Environments" link in https://eslint.org/docs/rules/no-undef#environments), Will be fixed by Docs: update configuring links #14038.
  • The actual site 301s https://eslint.org/docs/user-guide/configuring/ to https://eslint.org/docs/user-guide/configuring. The next version will be doing the opposite. Could that make any problems (caches, SEO...)?

@mdjermanovic mdjermanovic added the documentation label Jan 26, 2021
Copy link
Member

@aladdin-add aladdin-add left a comment

it's no longer required - we have docs/user-guide/configuring/README.md

@nzakas
Copy link
Member

nzakas commented Jan 27, 2021

I think the 301s should be okay. If we are concerned, I think we can configure that behavior in Netlify.

@mdjermanovic
Copy link
Member Author

mdjermanovic commented Jan 28, 2021

My concern is if someone (user or crawler) has somewhere cached that https://eslint.org/docs/user-guide/configuring/ redirects to https://eslint.org/docs/user-guide/configuring (current URL), what will happen when we release the new version where https://eslint.org/docs/user-guide/configuring redirects back to https://eslint.org/docs/user-guide/configuring/ (new URL).

Hopefully, it will ask again for https://eslint.org/docs/user-guide/configuring/ before treating this as a cyclic redirect.

@nzakas
Copy link
Member

nzakas commented Jan 28, 2021

301s are temporary redirects, so there should be minimal caching, if any.

@mdjermanovic
Copy link
Member Author

mdjermanovic commented Jan 28, 2021

301 is permanent redirect, 302 is temporary.

https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/301

Copy link
Member

@btmills btmills left a comment

What's our backup plan if it turns out the preexisting 301 from configuring/ to configuring ends up breaking something in combination with the new 301 from configuring back to configuring/? Rename the new docs to configuration/ and redirect configuring/? there?

@mdjermanovic
Copy link
Member Author

mdjermanovic commented Jan 29, 2021

What's our backup plan if it turns out the preexisting 301 from configuring/ to configuring ends up breaking something in combination with the new 301 from configuring back to configuring/? Rename the new docs to configuration/ and redirect configuring/? there?

Sounds good to me!

@btmills btmills merged commit 0ccf6d2 into master Jan 30, 2021
13 checks passed
@btmills btmills deleted the remove-configuring.md branch Jan 30, 2021
This was referenced Mar 17, 2021
vzvu3k6k added a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 7, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
vzvu3k6k added a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 7, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
ljharb pushed a commit to vzvu3k6k/eslint-plugin-react that referenced this issue May 9, 2021
Documentation about "Adding Shared Settings" is moved by
eslint/eslint#13837 and eslint/eslint#14036.
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jul 30, 2021
@eslint-github-bot eslint-github-bot bot added the archived due to age label Jul 30, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants