adonisjs / v6-docs

Documentation website for AdonisJS v6
42 stars 69 forks source link

Installation error with yarn #73

Closed Raesta closed 5 months ago

Raesta commented 6 months ago

Hey,

I have already talked about this privately with @Julien-R44, so here is the issue I encountered while following the documentation.

During installation via the command yarn create adonisjs@latest hello-world, I encountered an error.

image

This error is because the keyword latest does not exist since Yarn by default takes the latest version.

You can specify a version, of course, but not use this keyword.

PR to fix the "problem" : https://github.com/adonisjs/v6-docs/pull/74

Julien-R44 commented 6 months ago

I think there are a few things to make sure of :

So we should make sure that yarn create adonisjs with Yarn 4 uses the latest version of create-adonisjs. But I think it will not.

Otherwise, if a guy is using Yarn 4 and we recommend to use yarn create adonisjs without the @latest, he will probably download an older version of create-adonisjs

Or, rather than bother. Just indicate in the documentation that only Yarn 4 is supported. I would say this is probably our better option, as there is always a lot of trouble with Yarn Classic

Raesta commented 6 months ago

For more context, i use OSX & install with brew : https://formulae.brew.sh/formula/yarn

But use 1.x version of yarn :-(

A solution : I could put 2 sections, yarn <=4 & yarn >4 or yarn 1.x & yarn (others)

Julien-R44 commented 6 months ago

@RomainLanz any opinions? since you know Yarn way better than me

RomainLanz commented 6 months ago

IMO, we should remove any mention of yarn or pnpm, if people want to use something else than what is the default in Node.js, they should know how their tool work.

Aside, Yarn Classic (1.0) should not be used, I don't see any reason why we should have a special documentation for it. Upgrade your CLI version.

thetutlage commented 6 months ago

I agree with @RomainLanz here. Making different package managers work is outside of our scope. So, let's keep docs for just npm.

Raesta commented 5 months ago

@RomainLanz @thetutlage All right, I've made the changes to follow your point.

We need to apply this to all doc ? (If yes, I'll update soon)

thetutlage commented 5 months ago

Yes, we should

Raesta commented 5 months ago

@thetutlage I have made modifications throughout the entire documentation.