Move from gitbook to docusaurus, build docs in Travis CI (#10970)
* fix: ignore unknown fields in more RPC responses * Remove mdbook infrastructure * Delete gitattributes and other theme related items Move all docs to /docs folder to support Docusaurus * all docs need to be moved to /docs * can be changed in the future Add Docusaurus infrastructure * initialize docusaurus repo Remove trailing whitespace, add support for eslint Change Docusaurus configuration to support `src` * No need to rename the folder! Change a setting and we're all good to go. * Fixing rebase items * Remove unneccessary markdown file, fix type * Some fonts are hard to read. Others, not so much. Rubik, you've been sidelined. Roboto, into the limelight! * As much as we all love tutorials, I think we all can navigate around a markdown file. Say goodbye, `mdx.md`. * Setup deployment infrastructure * Move docs job from buildkite to travic * Fix travis config * Add vercel token to travis config * Only deploy docs after merge * Docker rust env * Revert "Docker rust env" This reverts commit f84bc208e807aab1c0d97c7588bbfada1fedfa7c. * Build CLI usage from docker * Pacify shellcheck * Run job on PR and new commits for publication * Update README * Fix svg image building * shellcheck Co-authored-by: Michael Vines <mvines@gmail.com> Co-authored-by: Ryan Shea <rmshea@users.noreply.github.com> Co-authored-by: publish-docs.sh <maintainers@solana.com>
This commit is contained in:
Dan Albert
GitHub
@@ -1,28 +1,31 @@
|
||||
# Install the Solana Tool Suite
|
||||
---
|
||||
title: Install the Solana Tool Suite
|
||||
---
|
||||
|
||||
There are multiple ways to install the Solana tools on your computer
|
||||
depending on your preferred workflow:
|
||||
- [Use Solana's Install Tool (Simplest option)](#use-solanas-install-tool)
|
||||
- [Download Prebuilt Binaries](#download-prebuilt-binaries)
|
||||
- [Build from Source](#build-from-source)
|
||||
|
||||
- [Use Solana's Install Tool (Simplest option)](#use-solanas-install-tool)
|
||||
- [Download Prebuilt Binaries](#download-prebuilt-binaries)
|
||||
- [Build from Source](#build-from-source)
|
||||
|
||||
## Use Solana's Install Tool
|
||||
|
||||
### MacOS & Linux
|
||||
|
||||
- Open your favorite Terminal application
|
||||
- Open your favorite Terminal application
|
||||
|
||||
- Install the Solana release
|
||||
[LATEST_SOLANA_RELEASE_VERSION](https://github.com/solana-labs/solana/releases/tag/LATEST_SOLANA_RELEASE_VERSION) on your
|
||||
machine by running:
|
||||
- Install the Solana release
|
||||
[LATEST_SOLANA_RELEASE_VERSION](https://github.com/solana-labs/solana/releases/tag/LATEST_SOLANA_RELEASE_VERSION) on your
|
||||
machine by running:
|
||||
|
||||
```bash
|
||||
curl -sSf https://raw.githubusercontent.com/solana-labs/solana/LATEST_SOLANA_RELEASE_VERSION/install/solana-install-init.sh | sh -s - LATEST_SOLANA_RELEASE_VERSION
|
||||
```
|
||||
|
||||
- If you are connecting to a different testnet, you can replace `LATEST_SOLANA_RELEASE_VERSION` with the
|
||||
release tag matching the software version of your desired testnet, or replace it
|
||||
with the named channel `stable`, `beta`, or `edge`.
|
||||
- If you are connecting to a different testnet, you can replace `LATEST_SOLANA_RELEASE_VERSION` with the
|
||||
release tag matching the software version of your desired testnet, or replace it
|
||||
with the named channel `stable`, `beta`, or `edge`.
|
||||
|
||||
- The following output indicates a successful update:
|
||||
|
||||
@@ -36,59 +39,64 @@ Active release directory: /home/solana/.local/share/solana/install/active_releas
|
||||
Update successful
|
||||
```
|
||||
|
||||
- Depending on your system, the end of the installer messaging may prompt you
|
||||
to
|
||||
```bash
|
||||
- Depending on your system, the end of the installer messaging may prompt you
|
||||
to
|
||||
|
||||
```bash
|
||||
Please update your PATH environment variable to include the solana programs:
|
||||
```
|
||||
- If you get the above message, copy and paste the recommended command below
|
||||
it to update `PATH`
|
||||
- Confirm you have the desired version of `solana` installed by running:
|
||||
```bash
|
||||
solana --version
|
||||
|
||||
- If you get the above message, copy and paste the recommended command below
|
||||
it to update `PATH`
|
||||
- Confirm you have the desired version of `solana` installed by running:
|
||||
|
||||
```bash
|
||||
solana --version
|
||||
```
|
||||
|
||||
- After a successful install, `solana-install update` may be used to easily
|
||||
update the Solana software to a newer version at any time.
|
||||
- After a successful install, `solana-install update` may be used to easily
|
||||
update the Solana software to a newer version at any time.
|
||||
|
||||
***
|
||||
---
|
||||
|
||||
###Windows
|
||||
|
||||
- Open a Command Prompt (`cmd.exe`) as an Administrator
|
||||
- Search for Command Prompt in the Windows search bar. When the Command
|
||||
Prompt app appears, right-click and select “Open as Administrator”.
|
||||
If you are prompted by a pop-up window asking “Do you want to allow this app to
|
||||
make changes to your device?”, click Yes.
|
||||
- Open a Command Prompt (`cmd.exe`) as an Administrator
|
||||
|
||||
- Copy and paste the following command, then press Enter to download the Solana
|
||||
installer into a temporary directory:
|
||||
- Search for Command Prompt in the Windows search bar. When the Command
|
||||
Prompt app appears, right-click and select “Open as Administrator”.
|
||||
If you are prompted by a pop-up window asking “Do you want to allow this app to
|
||||
make changes to your device?”, click Yes.
|
||||
|
||||
- Copy and paste the following command, then press Enter to download the Solana
|
||||
installer into a temporary directory:
|
||||
|
||||
```bash
|
||||
curl http://release.solana.com/LATEST_SOLANA_RELEASE_VERSION/solana-install-init-x86_64-pc-windows-gnu.exe --output C:\solana-install-tmp\solana-install-init.exe --create-dirs
|
||||
```
|
||||
|
||||
- Copy and paste the following command, then press Enter to install the latest
|
||||
version of Solana. If you see a security pop-up by your system, please select
|
||||
to allow the program to run.
|
||||
- Copy and paste the following command, then press Enter to install the latest
|
||||
version of Solana. If you see a security pop-up by your system, please select
|
||||
to allow the program to run.
|
||||
|
||||
```bash
|
||||
C:\solana-install-tmp\solana-install-init.exe LATEST_SOLANA_RELEASE_VERSION
|
||||
```
|
||||
|
||||
- When the installer is finished, press Enter.
|
||||
- When the installer is finished, press Enter.
|
||||
|
||||
- Close the command prompt window and re-open a new command prompt window as a
|
||||
normal user
|
||||
- Search for "Command Prompt" in the search bar, then left click on the
|
||||
Command Prompt app icon, no need to run as Administrator)
|
||||
- Confirm you have the desired version of `solana` installed by entering:
|
||||
```bash
|
||||
solana --version
|
||||
- Close the command prompt window and re-open a new command prompt window as a
|
||||
normal user
|
||||
- Search for "Command Prompt" in the search bar, then left click on the
|
||||
Command Prompt app icon, no need to run as Administrator)
|
||||
- Confirm you have the desired version of `solana` installed by entering:
|
||||
|
||||
```bash
|
||||
solana --version
|
||||
```
|
||||
|
||||
- After a successful install, `solana-install update` may be used to easily
|
||||
update the Solana software to a newer version at any time.
|
||||
- After a successful install, `solana-install update` may be used to easily
|
||||
update the Solana software to a newer version at any time.
|
||||
|
||||
## Download Prebuilt Binaries
|
||||
|
||||
@@ -99,7 +107,7 @@ manually download and install the binaries.
|
||||
|
||||
Download the binaries by navigating to
|
||||
[https://github.com/solana-labs/solana/releases/latest](https://github.com/solana-labs/solana/releases/latest),
|
||||
download **solana-release-x86\_64-unknown-linux-gnu.tar.bz2**, then extract the
|
||||
download **solana-release-x86_64-unknown-linux-gnu.tar.bz2**, then extract the
|
||||
archive:
|
||||
|
||||
```bash
|
||||
@@ -112,7 +120,7 @@ export PATH=$PWD/bin:$PATH
|
||||
|
||||
Download the binaries by navigating to
|
||||
[https://github.com/solana-labs/solana/releases/latest](https://github.com/solana-labs/solana/releases/latest),
|
||||
download **solana-release-x86\_64-apple-darwin.tar.bz2**, then extract the
|
||||
download **solana-release-x86_64-apple-darwin.tar.bz2**, then extract the
|
||||
archive:
|
||||
|
||||
```bash
|
||||
@@ -124,12 +132,12 @@ export PATH=$PWD/bin:$PATH
|
||||
### Windows
|
||||
|
||||
- Download the binaries by navigating to
|
||||
[https://github.com/solana-labs/solana/releases/latest](https://github.com/solana-labs/solana/releases/latest),
|
||||
download **solana-release-x86\_64-pc-windows-gnu.tar.bz2**, then extract the
|
||||
archive using WinZip or similar.
|
||||
[https://github.com/solana-labs/solana/releases/latest](https://github.com/solana-labs/solana/releases/latest),
|
||||
download **solana-release-x86_64-pc-windows-gnu.tar.bz2**, then extract the
|
||||
archive using WinZip or similar.
|
||||
|
||||
- Open a Command Prompt and navigate to the directory into which you extracted
|
||||
the binaries and run:
|
||||
the binaries and run:
|
||||
|
||||
```bash
|
||||
cd solana-release/
|
||||
|
||||
Reference in New Issue
Block a user