geldata / geldata/gel-cli

usability issues in https://www.edgedb.com/install

Open
#1,103 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
175
Forks
32
PR merge metrics
No merged PRs in 30d

Description

Using the instructions for installation found at https://www.edgedb.com/install. The first "quick" install process was followed. The following usability issues exist in the documentation. I was mostly able to complete the process but the documentation was less clear than it could be.

1. I am often installing as root. On looking at the quick install instructions, my first question was "Do I need to be root to do this?". I made a guess that I did not and that turned out to be correct but I would have liked it to instruct me to do this as your regular user.
1. The curl command downloads a shell script which is piped into sh for direct execution. The script could be saved and run with various options that could be useful. The script options are not documented nor is the existence of the options documented.
1. When the script ran, I chose option 2 - custom install - because I wanted to see what could change. The script offered me a customization to change the path. I was not clear if this was offering to change the installation path or the PATH var. I believe it was the latter but that was bit counter-intuitive because most installers offer you the option to change the installation path.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.