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.

Sign up for GitHub

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

docs: add a point about ubuntu 24.04 #619

Merged
merged 3 commits into from
Dec 2, 2024
Merged

docs: add a point about ubuntu 24.04 #619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
4f57745
docs: add a point about ubuntu 24.04
th7nder Nov 29, 2024
3a6c9e4
docs: add some disclaimers
th7nder Dec 2, 2024
65a153b
docs: move warning about the binaries lower
th7nder Dec 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/src/getting-started/building/source.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ git clone [email protected]:eigerco/polka-storage.git
cd polka-storage
```

<!-- I'm not sure about this section name -->
## System dependencies

To build the binaries directly on your system you will need the following tools:
Expand All @@ -44,6 +43,11 @@ $ sudo apt install -y libhwloc-dev \
curl
```

<div class="warning">
Not all of the binaries can be built from the polka-storage repository!
We depend on the <a href="https://github.com/paritytech/zombienet/releases/tag/v1.3.116">zombienet</a> and <a href="https://github.com/paritytech/polkadot-sdk/releases/tag/polkadot-stable2409-2">polkadot, polkadot-prepare-worker, polkadot-execute-worker</a> binaries which need to be downloaded regardless (if not using <a href="#using-nix">Nix</a>).
</div>

## Using Nix

You can use Nix to simplify the building process,
Expand Down
1 change: 1 addition & 0 deletions docs/src/getting-started/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ This chapter goes through the process of setting up, running, and trying out the
Before proceeding with the setup, please ensure the host system meets the following requirements:

- **OS**: Linux x86_64/MacOS ARM x64
- [Precompiled binaries](./local-testnet/index.md#native-binaries) were compiled under Ubuntu 24.04.1 LTS (glibc 2.39+).
- **RAM**: Minimum 8GB, recommended 16GB or more

## Guides
Expand Down
2 changes: 1 addition & 1 deletion docs/src/getting-started/local-testnet/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Charlie will be our contact point to the parachain network.
## Native Binaries

The binaries for the latest releases are available to download and can be run without any additional dependencies.
We support `Linux x86_64` and `MacOS ARM x64`. The commands below will download:
We support `Linux x86_64 (Ubuntu 24.04.1 LTS/glibc 2.39+)` and `MacOS ARM x64`. The commands below will download:

- [Relay Chain](https://github.com/paritytech/polkadot-sdk/releases) binaries (`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`),
- Polka Storage Parachain binary (`polka-storage-node`),
Expand Down
2 changes: 0 additions & 2 deletions docs/src/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,6 @@ We've now completed Phase 2 and have started work on Phase 3.
- Proof of Replication
- Proof of Spacetime

<!-- TODO: pending change from konrads PR -->

We also present a complete [real-world scenario](./getting-started/demo-file-store.md) in which a [Storage Provider](./glossary.md#storage-provider) and a [Storage User](./glossary.md#storage-user) negotiate a deal, perform all the steps necessary to start the storage and then receive rewards (or punishments) for making it happen.

**The Polka Storage project currently provides:**
Expand Down