Setup Guide for v3 doesn't work

[sans-clue]

Hello,

I'm trying to evaluate OSLS v3 and started by following the v3 Getting Started guide:

https://github.com/oss-serverless/osls/blob/3.x/docs/getting-started.md

A few things don't seem to match the current behavior:

• npm install -g osls@4 fails because the package can't be found. I assume that's expected since v4 is still in beta.
• I installed the latest v3 release instead.
• Running serverless doesn't appear to do anything.
• serverless init is not recognized as a command.
• serverless create --template=... appears to exist, but the template links referenced by the documentation return 404s.

I understand OSLS is intended to be a drop-in replacement for Serverless Framework and that I can likely create a project manually. However, I wanted to follow the documented workflow to understand the intended setup experience.

Am I missing a step, or is the v3 Getting Started guide currently out of date?

Thanks for any clarification.

[GrahamCampbell]

Yes, the npm install -g osls@4 docs are not ideal because we have not yet relased 4.0.0. If you are coming to this project as a new user, I'd strongly recommend using the beta v4 instead of v3. You can use @beta I think in the meanwhile. The 4.0.0 stable release is coming very soon, maybe as soon as today.

The serverless command not getting picked up is likely an npm bin path environment issue.

The --template is functionally broken because it points to all broken old templates from upstream serverless. --template-url should be used instead. Yes, the documentation is out of date. We don't really have any templates at the moment, and we should recommend something else.

[sans-clue]

Yes, the npm install -g osls@4 docs are not ideal because we have not yet relased 4.0.0. If you are coming to this project as a new user, I'd strongly recommend using the beta v4 instead of v3. You can use @beta I think in the meanwhile. The 4.0.0 stable release is coming very soon, maybe as soon as today.

Oh, I ended up using v3. I'll switch to beta but why is that better? (for my own edification, if you don't mind).

The serverless command not getting picked up is likely an npm bin path environment issue.

I'm not sure that's the issue, the command is in the path. I can call other commands like help and create. It's just that serverless literally does nothing, at least not on v3.

I can look into it further but, I'm not on my laptop atm.

[AimeurAmin]

Yes, the npm install -g osls@4 docs are not ideal because we have not yet relased 4.0.0. If you are coming to this project as a new user, I'd strongly recommend using the beta v4 instead of v3. You can use @beta I think in the meanwhile. The 4.0.0 stable release is coming very soon, maybe as soon as today.

The serverless command not getting picked up is likely an npm bin path environment issue.

The --template is functionally broken because it points to all broken old templates from upstream serverless. --template-url should be used instead. Yes, the documentation is out of date. We don't really have any templates at the moment, and we should recommend something else.

@GrahamCampbell
Any updates on the v4 stable version release?

[AimeurAmin]

Yes, the npm install -g osls@4 docs are not ideal because we have not yet relased 4.0.0. If you are coming to this project as a new user, I'd strongly recommend using the beta v4 instead of v3. You can use @beta I think in the meanwhile. The 4.0.0 stable release is coming very soon, maybe as soon as today.

The serverless command not getting picked up is likely an npm bin path environment issue.

The --template is functionally broken because it points to all broken old templates from upstream serverless. --template-url should be used instead. Yes, the documentation is out of date. We don't really have any templates at the moment, and we should recommend something else.

@GrahamCampbell

release of 4.0.0 coming out any time soon?

[mnapoli]

@AimeurAmin stop asking this is inappropriate. It will be released when it will be, and if anyone can give you any date they will, this is open-source.

[AimeurAmin]

@AimeurAmin stop asking this is inappropriate. It will be released when it will be, and if anyone can give you any date they will, this is open-source.

Apologies if I struck a nerve there, I won't ask again. Thanks for the feedback.

[GrahamCampbell]

@AimeurAmin The best thing you can do to help us be able to release 4.0.0 stable is to try out the beta and provide feedback.