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

Impressions about the docs for Node.js #321

Open
feremabraz opened this issue Oct 23, 2020 · 2 comments
Open

Impressions about the docs for Node.js #321

feremabraz opened this issue Oct 23, 2020 · 2 comments

Comments

@feremabraz
Copy link

feremabraz commented Oct 23, 2020

This is not an issue, but a suggestion. Nevertheless, I think it's important.
My impression is that the docs for installing gauge (https://docs.gauge.org/getting_started/installing-gauge.html?os=linux&language=javascript&ide=vscode) could feel daunting for some Node.js users, specially newbies. Maybe it will scare some people out of trying it.
Although the page looks cool and works well, I think that just the classic npm install -g @getgauge/cli yarn global add @getgauge/cli would be better as the main instruction. Just my two cents. Feel free to close this issue.

@zabil
Copy link
Member

zabil commented Oct 23, 2020

@appzillamonster that's a fair point.

When the docs were authored the npm installer was experimental. It's working well now and yes it makes sense to use npm for installing gauge as node is a pre-requisite.

Do you want to raise a PR for this? You can move the debian installer instruction to alternate methods.

@feremabraz
Copy link
Author

Okay, cool. Will do. Give me a little time.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants