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

Serenity/JS docs should be more Windows-friendly #1915

Closed
2 of 3 tasks
jan-molak opened this issue Sep 9, 2023 · 0 comments
Closed
2 of 3 tasks

Serenity/JS docs should be more Windows-friendly #1915

jan-molak opened this issue Sep 9, 2023 · 0 comments
Labels
documentation Issues with documentation or example projects good-first-issue Good for newcomers

Comments

@jan-molak
Copy link
Member

jan-molak commented Sep 9, 2023

What's the problem you're trying to solve?

To improve readability, many npm install commands described at serenity-js.org rely on bash brace expansion. For example:

npm install --save-dev @serenity-js/{code,rest,console-reporter}

However, Windows does not support this syntax and attempts to execute a command like this result in an error:

screenshot

How would you like to solve it?

Since commands relying on bash brace expansion are used on the website and in the readme files, we should use one command syntax that works across the OS-es, even at the cost of decreased readability (since most people will probably just copy and paste them anyway).

Are there any alternatives?

We could recommend to Windows users to use WSL instead of Windows terminals, but setting it up might not be convenient or even possible in many corporate settings.

How can we make it happen?

@jan-molak jan-molak added documentation Issues with documentation or example projects good-first-issue Good for newcomers labels Sep 9, 2023
jan-molak added a commit that referenced this issue Sep 10, 2023
…dows users

Windows terminal doesn't support Bash brace expansion, which means that developers using Windows
might have found the installation instructions confusing.

Related tickets: #1915
jan-molak added a commit that referenced this issue Sep 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issues with documentation or example projects good-first-issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant