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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Adds deprecated callouts to working-with-rules-deprecated page. #14344

Merged
merged 1 commit into from Apr 23, 2021

Conversation

manovotny
Copy link
Contributor

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:

What changes did you make? (Give an overview)

Added a couple of callouts (title and note) to the working-with-rules-deprecated page to better indicate to readers that the information on the page is deprecated.

I wound up on the working-with-rules-deprecated page via a google search or something, but I didn't notice that the page name had deprecated in it. As I was reading, I was like, this doesn't seem right... Took me a good 15 minutes to realize I was reading the old version. I figured adding a note to the top, similar to the note at the top of the working-with-rules page might be helpful in case anyone else winds up here like I did.

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

Not particularly. 馃槉

@eslint-github-bot eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Apr 20, 2021
@eslint-github-bot
Copy link

Hi @manovotny!, thanks for the Pull Request

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

  • The commit message tag must be one of the following:

    The Tag is one of the following:

    • Fix - for a bug fix.
    • Update - either for a backwards-compatible enhancement or for a rule change that adds reported problems.
    • New - implements a new feature.
    • Breaking - for a backwards-incompatible enhancement or feature.
    • Docs - changes to documentation only.
    • Build - changes to build process only.
    • Upgrade - for a dependency upgrade.
    • Chore - for anything that isn't user-facing (for example, refactoring, adding tests, etc.).

    You can use the labels of the issue you are working on to determine the best tag.

  • There should be a space following the initial tag and colon, for example 'New: Message'.

Read more about contributing to ESLint here

@manovotny manovotny force-pushed the working-with-rules-deprecated branch from c905d67 to 56b391d Compare April 20, 2021 16:50
@manovotny manovotny changed the title Adds deprecated callouts to working-with-rules-deprecated page. Docs: Adds deprecated callouts to working-with-rules-deprecated page. Apr 20, 2021
@mdjermanovic mdjermanovic added documentation Relates to ESLint's documentation and removed triage An ESLint team member will look at this issue soon labels Apr 21, 2021
@mdjermanovic
Copy link
Member

Thanks for the PR! This change makes a lot of sense.

@mdjermanovic mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Apr 21, 2021
Copy link
Member

@mdjermanovic mdjermanovic 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!

@mdjermanovic mdjermanovic merged commit 0023872 into eslint:master Apr 23, 2021
@mdjermanovic
Copy link
Member

Thanks for contributing!

@manovotny
Copy link
Contributor Author

You're welcome! 馃槉

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Oct 21, 2021
@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 Oct 21, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion 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
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants