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

Clarify installation page #828

Merged
merged 7 commits into from
Sep 19, 2023
Merged

Clarify installation page #828

merged 7 commits into from
Sep 19, 2023

Conversation

simonrw
Copy link
Contributor

@simonrw simonrw commented Sep 18, 2023

Add some clarity to the getting started page.

  • Make getting started sections consistent community vs pro
  • Include section on what the CLI does
  • Remove the word "just"
  • Add curl example commands

@simonrw simonrw self-assigned this Sep 18, 2023
@github-actions
Copy link

github-actions bot commented Sep 18, 2023

🎊 PR Preview has been successfully built and deployed to https://localstack-docs-preview-pr-828.surge.sh 🎊

@simonrw simonrw marked this pull request as ready for review September 19, 2023 14:03
@simonrw simonrw requested a review from alexrashed September 19, 2023 14:03
Copy link
Member

@alexrashed alexrashed left a 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
Copy link
Member

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).

Copy link
Contributor Author

@simonrw simonrw Sep 19, 2023

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 \
Copy link
Member

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.

Copy link
Contributor Author

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 \
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Same as above.

content/en/getting-started/installation.md Outdated Show resolved Hide resolved
content/en/getting-started/installation.md Outdated Show resolved Hide resolved
simonrw and others added 3 commits September 19, 2023 15:17
Co-authored-by: Alexander Rashed <[email protected]>
* Don't use Downloads dir
* Update macos command as well
@simonrw simonrw merged commit 7b7b20a into main Sep 19, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants