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 predefined configs example in FlatConfig announcement #574

Merged
merged 2 commits into from
Aug 12, 2024

Conversation

vadimcoder
Copy link
Contributor

Prerequisites checklist

What is the purpose of this pull request?

The purpose is to update the 2022 FlatConfig announcement according to the latest breaking changes because Google still shows this page in search results.

What changes did you make? (Give an overview)

Aligned the blogpost with the latest docs.

Related Issues

eslint/eslint#17488

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

have a good day

Copy link

linux-foundation-easycla bot commented May 27, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: amareshsm / name: Amaresh S M (710354c)
  • ✅ login: vadimcoder / name: Vadim (9f242d8)

@eslint-github-bot
Copy link

Hi @vadimcoder!, thanks for the Pull Request

The pull request title isn't properly formatted. We ask that you update the pull request title to match this format, as we use it to generate changelogs and automate releases.

  • The length of the commit message must be less than or equal to 72

To Fix: You can fix this problem by clicking 'Edit' next to the pull request title at the top of this page.

Read more about contributing to ESLint here

Copy link

netlify bot commented May 27, 2024

Deploy Preview for de-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/de-eslint/deploys/66ba1fc08c593a00084ada25
😎 Deploy Preview https://deploy-preview-574--de-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for es-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/es-eslint/deploys/66ba1fbfadb2a6000801b7f4
😎 Deploy Preview https://deploy-preview-574--es-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for ja-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/ja-eslint/deploys/66ba1fc024d30d0008896a0a
😎 Deploy Preview https://deploy-preview-574--ja-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for hi-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/hi-eslint/deploys/66ba1fc025aa5b000830682d
😎 Deploy Preview https://deploy-preview-574--hi-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for zh-hans-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/zh-hans-eslint/deploys/66ba1fc08bcfc80008cea199
😎 Deploy Preview https://deploy-preview-574--zh-hans-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for pt-br-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/pt-br-eslint/deploys/66ba1fc0a1dd6900084e9d33
😎 Deploy Preview https://deploy-preview-574--pt-br-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 configuration.

@vadimcoder vadimcoder changed the title docs: fix predefined configs example in FlatConfig announcement according to later breaking changes (because Google shows this page) docs: fix predefined configs example in FlatConfig announcement May 27, 2024
@eslint-github-bot eslint-github-bot bot added the documentation Improvements or additions to documentation label May 27, 2024
Copy link

netlify bot commented May 27, 2024

Deploy Preview for fr-eslint ready!

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/fr-eslint/deploys/66ba1fc0e061d00008640d9d
😎 Deploy Preview https://deploy-preview-574--fr-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 configuration.

Copy link

netlify bot commented May 27, 2024

Deploy Preview for new-eslint ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 710354c
🔍 Latest deploy log https://app.netlify.com/sites/new-eslint/deploys/66ba1fbf2e4fa70008970ae7
😎 Deploy Preview https://deploy-preview-574--new-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 configuration.

@mdjermanovic
Copy link
Member

because Google still shows this page in search results.

If this is the case, it might be better to add a note to the start of this blog post with a link to the latest docs.

@nzakas what do you think?

@vadimcoder
Copy link
Contributor Author

to add a note to the start of this blog post with a link to the latest docs

But the first link in the latest docs is the link to 2022 announcement (part 2) again:

To learn more about the flat config format, refer to this blog post.

Maybe it's worth replacing the link to Part 2 with the link to Part 1 because part 1 it's more philosophical and will remain relevant for a long time.

@nzakas
Copy link
Member

nzakas commented May 27, 2024

I'm fine with updating the blog post so long as we add a note about the update, like we did at the end of this post:

https://eslint.org/blog/2023/01/eslint-2022-year-review/

Adding a link to the current docs is probably a good idea, as well.

@nzakas
Copy link
Member

nzakas commented Jul 15, 2024

@vadimcoder all that's left here is just to add a note at the bottom that says this post was updated. Do you want to finish this up?

@amareshsm
Copy link
Member

@vadimcoder Are you still working on this?

@amareshsm
Copy link
Member

@vadimcoder all that's left here is just to add a note at the bottom that says this post was updated. Do you want to finish this up?

It has been pending for a long time. I have a note at the bottom and it is ready for review now.

@amareshsm amareshsm requested a review from nzakas August 12, 2024 14:45
Copy link
Member

@nzakas nzakas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks!

@nzakas nzakas merged commit 1f2d0fb into eslint:main Aug 12, 2024
37 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted documentation Improvements or additions to documentation
Projects
Status: Complete
Development

Successfully merging this pull request may close these issues.

4 participants