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

Improve installation instructions #474

Merged
merged 5 commits into from
Oct 24, 2024
Merged

Improve installation instructions #474

merged 5 commits into from
Oct 24, 2024

Conversation

gvdongen
Copy link
Contributor

@gvdongen gvdongen commented Oct 23, 2024

Installation instructions:

  • Change the order of the different options
  • Include running the CLI in Docker
  • Make the installation script more copy friendly by putting the sudo-commands in a separate snippet and adding sudo to them.

Quickstart:

  • Removed npx as an option whenever it wasn't relevant
  • Just keep either CLI or curl as the two options.

I asked Till to check if the --network=host for running the CLI in Docker works for MacOS

Copy link

cloudflare-workers-and-pages bot commented Oct 23, 2024

Deploying documentation with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6d66a2f
Status: ✅  Deploy successful!
Preview URL: https://fdcfa3c0.documentation-beg.pages.dev
Branch Preview URL: https://improve-onboarding.documentation-beg.pages.dev

View logs

Comment on lines 54 to 55
sudo mv restate $BIN && \
sudo mv restate-server $BIN
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not a big fan of sudo commands... I think most distro these days have a $HOME/.local/bin where u can copy without being root. Perhaps check if you have it on your machine as well

Copy link
Contributor

@slinkydeveloper slinkydeveloper left a comment

Choose a reason for hiding this comment

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

LGTM, this looks way better!

@gvdongen gvdongen merged commit 65eff6b into main Oct 24, 2024
2 checks passed
@gvdongen gvdongen deleted the improve_onboarding branch October 24, 2024 08:41
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