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: Clean up Getting Started Guide #12544

Merged
merged 1 commit into from Nov 8, 2019
Merged

Docs: Clean up Getting Started Guide #12544

merged 1 commit into from Nov 8, 2019

Conversation

@nzakas
Copy link
Member

nzakas commented Nov 7, 2019

What is the purpose of this pull request? (put an "X" next to 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)

Updated the Getting Started Guide by:

  1. Removing the video (very old at this point)
  2. Added mention of how to install ESLint via Yarn
  3. Added instructions on how to use npx to run ESLint instead of ./node_modules/.bin/eslint

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

Do the changes make sense?

@eslint eslint bot added the triage label Nov 7, 2019
@nzakas nzakas added documentation and removed triage labels Nov 7, 2019
docs/user-guide/getting-started.md Show resolved Hide resolved
@kaicataldo kaicataldo merged commit 0286b57 into master Nov 8, 2019
18 checks passed
18 checks passed
Verify Files
Details
Test (ubuntu-latest, 13.x)
Details
Test (ubuntu-latest, 12.x)
Details
Test (ubuntu-latest, 10.x)
Details
Test (ubuntu-latest, 8.x)
Details
Test (ubuntu-latest, 8.10.0)
Details
Test (windows-latest, 12.x)
Details
Test (macOS-latest, 12.x)
Details
Browser Test
Details
commit-message Commit message follows guidelines
Details
continuous-integration Build #20191107.16 succeeded
Details
continuous-integration (Test on Node.js 10 (Linux)) Test on Node.js 10 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Linux)) Test on Node.js 12 (Linux) succeeded
Details
continuous-integration (Test on Node.js 12 (Windows)) Test on Node.js 12 (Windows) succeeded
Details
continuous-integration (Test on Node.js 12 (macOS)) Test on Node.js 12 (macOS) succeeded
Details
continuous-integration (Test on Node.js 8 (Linux)) Test on Node.js 8 (Linux) succeeded
Details
licence/cla Contributor License Agreement is signed.
Details
release-monitor No patch release is pending
Details
@kaicataldo kaicataldo deleted the startguidecleanup branch Nov 8, 2019
@eslint eslint bot locked and limited conversation to collaborators May 8, 2020
@eslint eslint bot added the archived due to age label May 8, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.