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

Updates to install topic #6208

Merged
merged 10 commits into from
Nov 23, 2022
Merged

Updates to install topic #6208

merged 10 commits into from
Nov 23, 2022

Conversation

ronny-mysten
Copy link
Contributor

Updating install topic. Tested win 11 and macos.

@github-actions github-actions bot added the Type: Documentation Improvements or additions to documentation label Nov 18, 2022
@@ -4,69 +4,67 @@ title: Install Sui to Build

Learn how to install and configure Sui.
Copy link
Contributor

Choose a reason for hiding this comment

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

we should make this specific to installing for developers to build


This documentation is built from the same branches, `main` and `devnet`. The `main` branch includes the latest additions and updates to the documentation. You can view the content to learn about upcoming updates to the documentation, but the information may not be accurate or up-to-date for the features and functionality available in the `devnet` branch. In most cases, you should view the `devnet` version of the documentation.
The `main` and `devnet` branches of the Sui repository contain the relevant documentation for each branch. A version toggle on the documentation site enables you to switch between `main` branch content (labeled **Latest build**) and `devnet` branch content (labeled **Devnet**). Make sure the toggle is set to **Devnet** to learn how to install, configure, and build on Sui. The content in **Latest build** is useful to learn about potential updates to Sui, but is not guaranteed to be accurate for the features and functionality available in the `devnet` branch.
Copy link
Contributor

Choose a reason for hiding this comment

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

we can't currently guarantee that the devnet docs are accurate and current with the devnet branch of the repo either.

doc/src/build/install.md Outdated Show resolved Hide resolved

* Linux - Ubuntu version 18.04 (Bionic Beaver)
* macOS - macOS Monterey
* Microsoft Windows - Windows 11

## Prerequisites

Install the prerequisites and tools you need to work with Sui.
Install the prerequisites and tools you need to work with Sui. Click the
Copy link
Contributor

Choose a reason for hiding this comment

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

incomplete "click the " ?

| libclang-dev | [X](#libclang-dev) | | |
| Brew | | [X](#brew) | |
| C++ build tools | | | [X](#additional-tools-for-windows) |
| LLVM Compiler | | | [X](#additional-tools-for-windows) |
Copy link
Contributor

Choose a reason for hiding this comment

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

nice touch linking these - though if one clicks to an anchor later in the topic they may miss the Rust section that is separate from the OS sections



### Rust and Cargo

Sui requires Rust and Cargo on all supported operating systems.
Sui requires Rust and Cargo on all supported operating systems. Some operating systems require cURL to download Rust and Cargo, so check the relevant prerequisite section to install cURL first, if necessary.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we just say which of the 3 requires cURL to install it? If you use macOS, cURL comes with the OS, for Windows you need to install C++ build tools before you can install Rust

```shell
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
```

For additional installation options, see [Install Rust](https://www.rust-lang.org/tools/install).
Windows 11 users can use the [Rust installer](https://www.rust-lang.org/tools/install) available on the Rust website.
Copy link
Contributor

Choose a reason for hiding this comment

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

Mention that C++ tools is required before trying to install Rust?

| libssl-dev | [X](#libssl-dev) | | |
| libclang-dev | [X](#libclang-dev) | | |
| Brew | | [X](#brew) | |
| C++ build tools | | | [X](#additional-tools-for-windows) |
Copy link
Contributor

Choose a reason for hiding this comment

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

this is required to install Rust, so it should be in the Rust section as a mention rather than an additional tool


### Git CLI

Download and install the [Git command line interface](https://git-scm.com/download/)
for your operating system.
Download and install the [Git command line interface](https://git-scm.com/download/).
Copy link
Contributor

Choose a reason for hiding this comment

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

do any of the commands actually use the Git CLI? There is one gh clone in a topic, but that can also be done with just git. Why do we need Git CLI?



## Install Sui binaries

After you install Cargo, use the following command to install Sui binaries:
With Cargo installed, use the following command to install Sui binaries:
Copy link
Contributor

Choose a reason for hiding this comment

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

The compiled binaries are now included with each release. We need to include info on how to use those as well

@ronny-mysten ronny-mysten merged commit 773c505 into MystenLabs:main Nov 23, 2022
@ronny-mysten ronny-mysten deleted the sweet branch November 23, 2022 17:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants