docs: Switch to flat config by default #17840
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
What do you think of keeping the file with a link to the replacement to avoid breaking links? Likely a lot of guides/tickets/PRs link to this page for context. Similar to this discussion: #17792 (comment)
There was a problem hiding this comment.
We can just redirect outdated links, right?
There was a problem hiding this comment.
Either a link or redirect to the replacement is fine.
There was a problem hiding this comment.
Yeah, we'll do a redirect, but that needs to be done in the eslint.org repo.
There was a problem hiding this comment.
Since we are going to redirect, perhaps we should remove the configuration-files-new.md file now? It appears in the navigation:
There was a problem hiding this comment.
Looks like the configuration-files-new.md file is still here:
There was a problem hiding this comment.
It would be good to also update order fields in configuration documents. Since the rest of the changes look good, I'm going to merge this now to avoid future merge conflicts, and I'll submit another PR to update this.
nzakas
force-pushed
the
flat-config-docs-default
branch
from
8731982
to
27b0ab1
Compare
mdjermanovic
changed the title
nzakas
force-pushed
the
flat-config-docs-default
branch
from
27b0ab1
to
3496368
Compare
Co-authored-by: Percy Ma <kecrily@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
…nto flat-config-docs-default
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
…nto flat-config-docs-default
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
…nto flat-config-docs-default
* main: docs: Migrate to v9.0.0 (eslint#17905) docs: Switch to flat config by default (eslint#17840) docs: Update Create a Plugin for flat config (eslint#17826) feat!: add two more cases to `no-implicit-coercion` (eslint#17832) docs: Switch shareable config docs to use flat config (eslint#17827) chore: remove creating an unused instance of Linter in tests (eslint#17902) feat!: Switch Linter to flat config by default (eslint#17851)
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)
Switched the default configuration documentation to refer to flat config instead of eslintrc. Primarily, this involved taking all of the content on
configuration-files-new.mdand integrating it into the multi-page configuration documentation we already had. This required moving things around and removing duplicate content.Refs #13481
Is there anything you'd like reviewers to focus on?
Please double-check that I haven't left duplicate content in the files and that the structure makes sense. Everything isn't exactly 1-to-1 with eslintrc, so I did my best.