-
Notifications
You must be signed in to change notification settings - Fork 114
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
Clarify installation page #828
Conversation
🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-828.surge.sh 🎊 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Awesome! Thanks for proactively updating the docs! I only found a few nitpicks. 💯
@@ -30,13 +30,15 @@ LocalStack expects your API key to be present in the environment variable `LOCAL | |||
{{< tabpane >}} | |||
{{< tab header="macOS/Linux" lang="shell" >}} | |||
export LOCALSTACK_API_KEY=<YOUR_API_KEY> | |||
localstack start -d | |||
localstack start |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess it makes sense to not start in detached mode here, but then we should also change it in line 36 (instructions for windows).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This was made to be consistent with the community instructions. I'll update the windows docs as well.
<p> | ||
For <i>amd64</i>: | ||
{{< command >}} | ||
$ curl -Lo ~/Downloads/localstack-cli-{{< localstack-latest-version >}}-linux-amd64-onefile.tar.gz \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: I think we should not assume that there is a Downloads
folder in the home directory of the user, but just download it into the current working directory.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, I was making the curl command consistent with the tar unpack instructions. I'll update both to use the CWD 👍
<p> | ||
Or <i>arm64</i>: | ||
{{< command >}} | ||
$ curl -Lo ~/Downloads/localstack-cli-{{< localstack-latest-version >}}-linux-arm64-onefile.tar.gz \ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Same as above.
Co-authored-by: Alexander Rashed <[email protected]>
* Don't use Downloads dir * Update macos command as well
Add some clarity to the getting started page.