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

Consistently use yarn or npm across docs #4514

Closed
m-allanson opened this issue Mar 13, 2018 · 11 comments
Closed

Consistently use yarn or npm across docs #4514

m-allanson opened this issue Mar 13, 2018 · 11 comments
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@m-allanson
Copy link
Contributor

Across Gatsby's docs both yarn and npm are used interchangeably, which seems a bit confusing. The docs should consistently mention either yarn or npm. Or both?

@m-allanson m-allanson added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 13, 2018
@KyleAMathews
Copy link
Contributor

I always use NPM — but yeah, we should standardize that and fix anyone's any uses of Yarn.

@giladronat
Copy link
Contributor

@KyleAMathews I’d gladly make it all consistent and PR -- do you prefer standardizing to NPM because you use it or Yarn because it’s probably more common?

@shannonbux
Copy link
Contributor

shannonbux commented Mar 15, 2018

good question @giladronat and thanks for offering. @m-allanson I've wondered the same thing and been too new to know if I'm just missing something or if there are reasons for npm vs. yarn.

@shannonbux
Copy link
Contributor

And then I accidentally closed and opened this again haha. Still a github newb.

@KyleAMathews
Copy link
Contributor

@giladronat yeah NPM cause it's the default and anyone using Yarn is already familiar with translating instructions to Yarn. Thanks!

@giladronat
Copy link
Contributor

giladronat commented Mar 16, 2018

@KyleAMathews that makes sense. As a JS newbie that was recommended Yarn by friends, I don’t fall into that category, but I don’t know if I’m a representative sample. I’ll change to NPM though; most of the work is just finding all instances, not changing one way or another 😄
Edit: even as a newbie I’m actually able to figure it out, so NPM is probably best.

@webrune-tim
Copy link
Contributor

webrune-tim commented Mar 18, 2018

I am happy to help go through the docs looking for yarn and npn. Which do you prefer? I can update it.

@m-allanson
Copy link
Contributor Author

Thanks @giladronat!

And thanks @WebRuin too, but it looks like @giladronat is working on this one already.

@giladronat
Copy link
Contributor

This is done. Feel free to close @KyleAMathews

@KyleAMathews
Copy link
Contributor

Thanks @giladronat!

@eballeste
Copy link

eballeste commented Jan 29, 2019

i personally use npm but anytime i start a new gatsby project with gatsby new it automatically uses yarn in it's install process and throws an npm related warning:

warning package-lock.json found. Your project contains lock files generated by tools other than Yarn. It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files. To clear this warning, remove package-lock.json.

it also creates a yarn lock file in addition to the package-lock.json

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

6 participants