Skip to content

chore(website): streamlined Getting Started docs #5248

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.

Sign up for GitHub

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
Merged
merged 9 commits into from
Jul 22, 2022
Merged

chore(website): streamlined Getting Started docs #5248

merged 9 commits into from
Jul 22, 2022

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Jun 25, 2022 •
edited
Loading

PR Checklist

Overview

Applies an editing & streamlining pass to the Getting Started docs.

  • Merges the Linting your TypeScript Codebase file into Getting Started
    • Exceedingly few users care about developing an ESLint plugin in TypeScript; the extra jump was inconvenient for the majority
  • Moves Monorepo Configuration into Linting with Type Information since most users don't need it and it's only relevant for typed happenings
  • Moves What About TSLint? into Troubleshooting & FAQs since most users don't need it
  • Removes much of the Getting Started (Linting your TypeScript Codebase) information duplicated from core ESLint docs not necessary for the common path of linting .ts(x) files
  • Explicitly calls it "Quickstart" with numbered steps to help encourage users to directly follow the steps
  • Enables onBrokenMarkdownLinks and fixes remaining issues

Uses a Netlify _redirects file to preserve the old URLs in case external folks have already linked to them.

@nx-cloud
Copy link

nx-cloud bot commented Jun 25, 2022 •
edited
Loading

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8547ff6. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 47 targets

Sent with 💌 from NxCloud.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @JoshuaKGoldberg!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@netlify
Copy link

netlify bot commented Jun 25, 2022 •
edited
Loading

✅ Deploy Preview for typescript-eslint ready!

Name Link
🔨 Latest commit 8547ff6
🔍 Latest deploy log https://app.netlify.com/sites/typescript-eslint/deploys/62dadef5c8f29f0008f10efa
😎 Deploy Preview https://deploy-preview-5248--typescript-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 settings.

@codecov
Copy link

codecov bot commented Jun 25, 2022 •
edited
Loading

Codecov Report

Merging #5248 (bbd8692) into main (48f996e) will increase coverage by 2.42%.
The diff coverage is n/a.

❗ Current head bbd8692 differs from pull request most recent head 8547ff6. Consider uploading reports for the commit 8547ff6 to get more accurate results

@@            Coverage Diff             @@
##             main    #5248      +/-   ##
==========================================
+ Coverage   91.35%   93.77%   +2.42%     
==========================================
  Files         132      287     +155     
  Lines        1492     9884    +8392     
  Branches      226     2961    +2735     
==========================================
+ Hits         1363     9269    +7906     
- Misses         65      335     +270     
- Partials       64      280     +216
Flag Coverage Δ
unittest 93.77% <ø> (+2.42%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...s/eslint-plugin/src/rules/prefer-optional-chain.ts 94.21% <0.00%> (ø)
...es/eslint-plugin/src/rules/no-invalid-void-type.ts 95.12% <0.00%> (ø)
...-plugin/src/rules/explicit-function-return-type.ts 100.00% <0.00%> (ø)
...s/eslint-plugin/src/rules/no-dupe-class-members.ts 87.50% <0.00%> (ø)
...slint-plugin/src/rules/prefer-enum-initializers.ts 100.00% <0.00%> (ø)
...plugin/src/rules/naming-convention-utils/format.ts 83.33% <0.00%> (ø)
...slint-plugin/src/rules/no-unnecessary-condition.ts 98.30% <0.00%> (ø)
...ages/eslint-plugin/src/rules/no-empty-interface.ts 100.00% <0.00%> (ø)
...plugin/src/rules/naming-convention-utils/schema.ts 100.00% <0.00%> (ø)
packages/eslint-plugin/src/configs/base.ts 100.00% <0.00%> (ø)
... and 145 more

@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Jun 25, 2022
Closed
2 tasks
@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review June 25, 2022 20:10
This was referenced Jun 25, 2022
Closed
Closed
@bradzacher bradzacher added the package: website Issues related to the @typescript-eslint website label Jun 27, 2022
bradzacher
bradzacher previously approved these changes Jul 18, 2022
View reviewed changes
@JoshuaKGoldberg JoshuaKGoldberg enabled auto-merge (squash) July 22, 2022 17:31
@JoshuaKGoldberg JoshuaKGoldberg merged commit 7ea14ae into typescript-eslint:main Jul 22, 2022
@JoshuaKGoldberg JoshuaKGoldberg mentioned this pull request Jul 23, 2022
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 22, 2022
@JoshuaKGoldberg JoshuaKGoldberg deleted the streamlined-getting-started-docs branch December 24, 2022 09:09
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bradzacher bradzacher bradzacher approved these changes

Assignees
No one assigned
Labels
package: website Issues related to the @typescript-eslint website
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs: Proofread Getting Started guide for clarity
2 participants
@JoshuaKGoldberg @bradzacher