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: Update CLI docs to prefer local install #15513

Merged
merged 3 commits into from Jan 15, 2022
Merged

Conversation

nzakas
Copy link
Member

@nzakas nzakas commented Jan 12, 2022

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 autofix 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 CLI docs to use local install install of global. We don't recommend global install and so this was confusing for new users.

Also updated some of the code fences to "bash" from "sh" for better compatibility with the new syntax highlighter in the new website.

Fixes #15498

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

Did I catch all of the examples?

@eslint-github-bot eslint-github-bot bot added triage documentation labels Jan 12, 2022
@mdjermanovic mdjermanovic added accepted cli and removed triage labels Jan 12, 2022
@mdjermanovic mdjermanovic linked an issue Jan 12, 2022 that may be closed by this pull request
1 task
@mdjermanovic
Copy link
Member

mdjermanovic commented Jan 12, 2022

Did I catch all of the examples?

All examples in code blocks are correctly fixed to npx eslint. I'm just not sure if the inline examples are intentionally left without npx:

@nzakas
Copy link
Member Author

nzakas commented Jan 12, 2022

Thanks, I’ll update the inline examples too for consistency.

Copy link
Member

@aladdin-add aladdin-add left a comment

LGTM! 👍

Copy link
Contributor

@snitin315 snitin315 left a comment

LGTM

Copy link
Member

@mdjermanovic mdjermanovic left a comment

LGTM, thanks!

@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jul 15, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age label Jul 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted archived due to age cli documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants