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

Jump to bottom

Docs: add migration guide #12692

Merged
merged 76 commits into from May 7, 2020
Merged

Docs: add migration guide #12692

merged 76 commits into from May 7, 2020

Conversation

mysticatea
Copy link
Member

Don't merge until we finished releasing the last one of 6.x.

What is the purpose of this pull request? (put an "X" next to item)

[X] Documentation update

What changes did you make? (Give an overview)

This PR adds the draft of migration guide for 7.0.0. The purpose is to reduce the conflict of breaking change PRs.

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

Please correct the sentences.

@mysticatea mysticatea added documentation Relates to ESLint's documentation do not merge This pull request should not be merged yet labels Dec 20, 2019
@mysticatea mysticatea removed the do not merge This pull request should not be merged yet label May 4, 2020
@mysticatea
Copy link
Member Author

I have updated this PR.

@mysticatea mysticatea changed the title Docs: add draft of migration guide Docs: add migration guide May 4, 2020
kaicataldo
kaicataldo suggested changes May 4, 2020
View reviewed changes
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

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

Really appreciate you working on this, since I think you know the changes in this release better than the rest of us! I've made some editorial suggestions.

docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
mysticatea and others added 5 commits May 5, 2020 19:25
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
3b5016a 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
9740e61 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
32ed031 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
aabef13 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
87da93b 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea
Copy link
Member Author

mysticatea commented May 5, 2020 •
edited

I want to know how to keep open "hidden conversions" on applying suggestions...
image

I have to repeat the following steps:

  1. scroll up then find "hidden conversions"
  2. click "hidden conversions" and wait for loaded (for some reason, if I click it quickly, the PR page goes to broken...)
  3. scroll down then find the next suggestion
  4. check and apply it.
  5. the PR page is refreshed then goto 1...

mysticatea and others added 13 commits May 5, 2020 19:51
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
76ba496 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
4080ee9 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
6ec54c7 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
8469149 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
4de45ef 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
22f3c7f 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
8c0976d 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
2116525 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
e8f39f1 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
ce84f5f 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
0aa6295 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
32e09d9 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
2fe97f2 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
mysticatea and others added 15 commits May 5, 2020 21:33
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
1882714 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
ce6cd73 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
1088fd2 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
0b8a188 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
451bd00 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
b58b60b 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
269803b 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
2b51829 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
9ad9964 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
6881d81 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
55ac0f4 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
9a63741 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea @kaicataldo
Update docs/user-guide/migrating-to-7.0.0.md
867098b 
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
@mysticatea
remove $ eslint src block
1f1d4e4
@mysticatea
replace 7 and 7.0.0 by v7.0.0
1299a4a
@mysticatea
Copy link
Member Author

Thank you for your review! I have updated this PR.

@anikethsaha
Copy link
Member

anikethsaha commented May 5, 2020 •
edited

I think applying the batch suggestion feature would have been helpful when suggestions are many. (its a new feature from github)

platinumazure
platinumazure requested changes May 5, 2020
View reviewed changes
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

👋 Hi! I was taking a quick look through this and before I knew it, I found a few minor issues and started this review. Hope this helps, but feel free to ignore if not.

docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Show resolved Hide resolved
docs/user-guide/migrating-to-7.0.0.md Outdated Show resolved Hide resolved
mysticatea and others added 6 commits May 6, 2020 14:03
@mysticatea @platinumazure
Update docs/user-guide/migrating-to-7.0.0.md
ddf3b67 
Co-authored-by: Kevin Partington <platinum.azure@kernelpanicstudios.com>
@mysticatea @platinumazure
Update docs/user-guide/migrating-to-7.0.0.md
86ebcda 
Co-authored-by: Kevin Partington <platinum.azure@kernelpanicstudios.com>
@mysticatea
fix feature list
1e3e33d
@mysticatea
fix "may has"
79f805d
@mysticatea
fix "use directive comments to..."
d3257ee
@mysticatea
add "surrounded by whitespace"
ba479ab
platinumazure
platinumazure approved these changes May 6, 2020
View reviewed changes
Copy link
Member

@platinumazure platinumazure left a comment

Choose a reason for hiding this comment

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

Looks good to me. Thanks for incorporating my feedback!

kaicataldo
kaicataldo approved these changes May 7, 2020
View reviewed changes
Copy link
Member

@kaicataldo kaicataldo left a comment

Choose a reason for hiding this comment

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

Thank you for all your work on this! LGTM.

@kaicataldo kaicataldo merged commit 356fdb4 into master May 7, 2020
@kaicataldo kaicataldo deleted the migrating-guide-7 branch May 7, 2020 01:29
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Nov 4, 2020
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Nov 4, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@nzakas nzakas nzakas left review comments

@platinumazure platinumazure platinumazure approved these changes

@kaicataldo kaicataldo kaicataldo approved these changes

Assignees
No one assigned
Labels
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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@mysticatea @anikethsaha @nzakas @platinumazure @kaicataldo