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

Update build by source docs to add pre-requisites #34441

Merged
merged 3 commits into from
Dec 19, 2023

Conversation

jcleira
Copy link
Contributor

@jcleira jcleira commented Dec 13, 2023

Problem

I was building the Solana binary after following the Setup a Solana Validator guide.

I used a recently created VM for this, so I had a clean environment. I ran ./scripts/cargo-install-all.sh . up to four times because I didn't have the prerequisites to perform the build. Using a Build from source is encouraged in the guide

The build requirements are pretty standard and are likely to be maintained, but the failures might discourage non-developers from playing around and creating a validator node. This MR tries to fix this by providing extended information on prerequisites before triggering the build.

Summary of Changes

This MR updates the docs/src/cli/install.md page from the official documentation, adding the build prerequisites for Linux, macOS, and Windows.

@mergify mergify bot added community Community contribution need:merge-assist labels Dec 13, 2023
@mergify mergify bot requested a review from a team December 13, 2023 16:24
@jcleira jcleira changed the title Update build by source docs to add pre-requisites Draft: Update build by source docs to add pre-requisites Dec 13, 2023
@jcleira jcleira force-pushed the update-build-docs branch 4 times, most recently from 94add46 to 26c119a Compare December 13, 2023 16:37
@jcleira jcleira changed the title Draft: Update build by source docs to add pre-requisites Update build by source docs to add pre-requisites Dec 13, 2023
@jcleira
Copy link
Contributor Author

jcleira commented Dec 13, 2023

👋 Following the CONTRIBUTING.md guide, I'm pinging you for this MR, @nickfrosty, because a git blame revealed that you were the file author

@jcleira
Copy link
Contributor Author

jcleira commented Dec 14, 2023

This is how these changes looks like in the rendered docs
Screenshot 2023-12-14 at 07 38 30

@nickfrosty nickfrosty requested review from nickfrosty and removed request for a team December 15, 2023 19:35
@nickfrosty nickfrosty self-assigned this Dec 15, 2023
Copy link
Contributor

@nickfrosty nickfrosty left a comment

Choose a reason for hiding this comment

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

Thanks for the additions!

I recommend adding these suggested details about WSL to offer a clear backup for Windows users.

Can you also please run prettier on this file after accepting changes?
From the repo root:

npx --yes  prettier --write ./docs/src/cli/install.md 

docs/src/cli/install.md Show resolved Hide resolved
jcleira and others added 3 commits December 19, 2023 19:40
Copy link
Contributor

@nickfrosty nickfrosty left a comment

Choose a reason for hiding this comment

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

Thanks again for the updates!

@nickfrosty nickfrosty merged commit 97f02fa into solana-labs:master Dec 19, 2023
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Community contribution need:merge-assist
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants