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

chore: update getting-started.md #4287

Merged
merged 2 commits into from
Feb 14, 2022
Merged

Conversation

imballinst
Copy link
Contributor

@imballinst imballinst commented Feb 14, 2022

🎉 Thanks for submitting a pull request! 🎉

Summary

Fixes #4277

This PR updates the "locally" word to "globally" in the "Getting Started" section of the CLI documentation. The change to "globally" makes the section consistent, because the subsequent command installation has this global -g flag:

npm install netlify-cli -g

For us to review and ship your PR efficiently, please perform the following steps:

  • Open a bug/issue before writing your code 🧑‍💻. This ensures we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or something that`s on fire 🔥 (e.g. incident related), you can skip this step.
  • Read the contribution guidelines 📖. This ensures your code follows our style guide and
    passes our tests.
  • Update or add tests (if any source code was changed or added) 🧪
  • Update or add documentation (if features were changed or added) 📝
  • Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)

Here is a mini-size rabbit: 🐇

This PR updates the "locally" world to "globally", because the subsequent command installation has this global `-g` flag:

```bash
npm install netlify-cli -g
```

At least, that's how I see it. It was a bit confusing at me first when the caption is "locally" but the code snippet after has this `-g` flag. If this PR doesn't make sense, please feel free to close this. Thanks!
@imballinst imballinst requested a review from a team as a code owner February 14, 2022 10:51
@imballinst imballinst changed the title chore(docs): update getting-started.md chore: update getting-started.md Feb 14, 2022
@erezrokah erezrokah added the type: bug code to address defects in shipped code label Feb 14, 2022
@erezrokah
Copy link
Contributor

Thanks @imballinst 🥳

@erezrokah erezrokah added the automerge Add to Kodiak auto merge queue label Feb 14, 2022
@kodiakhq kodiakhq bot merged commit 7b6b94a into netlify:main Feb 14, 2022
@imballinst imballinst deleted the imballinst-patch-1 branch February 14, 2022 11:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automerge Add to Kodiak auto merge queue type: bug code to address defects in shipped code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: in getting-started.md, "locally perhaps should be "globally" instead?
2 participants