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

[WIP] docs: update dotnet and protoc version #3327

Merged
merged 3 commits into from
Sep 23, 2022
Merged

[WIP] docs: update dotnet and protoc version #3327

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
d21a936
docs: update dotnet and protoc version
zhxymh Sep 7, 2022
15d944e
Merge branch 'docs' into docs-1.2.1
eanzhao Sep 13, 2022
e03db44
docs: update protoc version
zhxymh Sep 15, 2022
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
18 changes: 9 additions & 9 deletions docs-sphinx/getting-started/development-environment/environment-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,9 +204,9 @@ Most of AElf is developed with dotnet core, so you will need to download
and install the .NET Core SDK before you start:

[Download .NET Core
3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1)
6.0](https://dotnet.microsoft.com/download/dotnet-core/6.0)

For now AElf depends on version 3.1 of the SDK, on the provided link
For now AElf depends on version 6.0 of the SDK, on the provided link
find the download for your platform (for Windows and macOS the installer
for x64 is the most convenient if your platform is compatible - most are
these days), the page looks like this:
Expand All @@ -230,18 +230,18 @@ Github](https://github.com/protocolbuffers/protobuf)):
On Windows, open a **Powershell** and enter the following commands:

``` bash
choco install protoc --version=3.11.4 -y
choco install protoc -y
choco upgrade unzip -y
```

On Linux:

``` bash
# Make sure you grab 3.11.4 for protoc
curl -OL https://github.com/google/protobuf/releases/download/v3.11.4/protoc-3.11.4-linux-x86_64.zip
# Make sure you grab 3.21.5 for protoc
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v21.5/protoc-21.5-linux-x86_64.zip

# Unzip
unzip protoc-3.11.4-linux-x86_64.zip -d protoc3
unzip protoc-21.5-linux-x86_64.zip -d protoc3

# Move protoc to /usr/local/bin/
sudo mv protoc3/bin/* /usr/local/bin/
Expand All @@ -257,11 +257,11 @@ sudo chown -R ${USER} /usr/local/include/google
on macOS:

``` bash
# Make sure you grab 3.11.4 for protoc
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v3.11.4/protoc-3.11.4-osx-x86_64.zip
# Make sure you grab 3.21.5 for protoc
curl -OL https://github.com/protocolbuffers/protobuf/releases/download/v21.5/protoc-21.5-osx-x86_64.zip

# Unzip
unzip protoc-3.11.4-osx-x86_64.zip -d protoc3
unzip protoc-21.5-osx-x86_64.zip -d protoc3

# Move protoc to /usr/local/bin/
sudo mv protoc3/bin/* /usr/local/bin/
Expand Down
2 changes: 1 addition & 1 deletion docs-sphinx/getting-started/development-environment/run-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ Now we build and run the node navigate into the **aelf** directory and build the

```bash
dotnet build AElf.Launcher.csproj --configuration Release
dotnet bin/Release/netcoreapp3.1/AElf.Launcher.dll > aelf-logs.logs &
dotnet bin/Release/net6.0/AElf.Launcher.dll > aelf-logs.logs &
cd ..
```

Expand Down
Binary file modified docs-sphinx/getting-started/development-environment/setup-dotnet-sdk-dl-link.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion ...getting-started/smart-contract-development/developing-smart-contracts/setup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Boilerplate’s internal node.
dotnet build

# run the node
dotnet run --no-build bin/Debug/netcoreapp3.1/AElf.Boilerplate.Launcher
dotnet run --no-build bin/Debug/net6.0/AElf.Boilerplate.Launcher

{% hint style=“warning” %} When running Boilerplate, you might see some
errors related to an incorrect password, to solve this, you need to
Expand Down
2 changes: 1 addition & 1 deletion docs-sphinx/reference/contract-sdk/csharp/contract-sdk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -671,7 +671,7 @@ Parameters
| | -us/dotnet/api/ | |
| | system.func-1?v | |
| | iew=netcore | |
| | -3.1>`__ | |
| | -6.0>`__ | |
+--------------+-----------------+----------------------------------------+

.. _AElf-Sdk-CSharp-CSharpSmartContractContext-RecoverPublicKey:
Expand Down
2 changes: 1 addition & 1 deletion docs-sphinx/reference/contract-sdk/csharp/core-sdk.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ Parameters
=========== ================================================================================================ ===================================
Name Type Description
=========== ================================================================================================ ===================================
serializer `System.Func <https://docs.microsoft.com/en-us/dotnet/api/system.func-1?view=netcore-3.1>`__ Function that will be used to
serializer `System.Func <https://docs.microsoft.com/en-us/dotnet/api/system.func-1?view=netcore-6.0>`__ Function that will be used to
deserialize messages.
=========== ================================================================================================ ===================================

Expand Down
2 changes: 1 addition & 1 deletion docs-sphinx/tutorials/__run-node.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Now we will build and run the node with the following commands:

```bash
dotnet build AElf.Launcher.csproj --configuration Release
dotnet bin/Release/netcoreapp3.1/AElf.Launcher.dll > aelf-logs.logs &
dotnet bin/Release/net6.0/AElf.Launcher.dll > aelf-logs.logs &
cd ..
```

Expand Down
6 changes: 3 additions & 3 deletions docs-sphinx/tutorials/mainnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ Running a full node with the binary release
Most of AElf is developed with dotnet core, so to run the binaries you
will need to download and install the .NET Core SDK before you start:
[Download .NET Core
3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1). For now
AElf depends on version 3.1 of the SDK, on the provided link find the
6.0](https://dotnet.microsoft.com/download/dotnet-core/6.0). For now
AElf depends on version 6.0 of the SDK, on the provided link find the
download for your platform, and install it.

Get the latest release with the following commands:
Expand All @@ -228,7 +228,7 @@ packages, but if you want you can compile from source code. First make
sure the code version is consistent (current is release AELF
v1.0.0), and secondly make sure to compile on a Ubuntu Linux
machine (we recommend Ubuntu 18.04.2 LTS) and have dotnet core SDK
version 3.1 installed. This is because different platforms or compilers
version 6.0 installed. This is because different platforms or compilers
will cause the dll hashes to be inconsistent with the current chain.

Check the node
Expand Down
6 changes: 3 additions & 3 deletions docs-sphinx/tutorials/testnet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,8 +201,8 @@ Running a full node with the binary release
Most of AElf is developed with dotnet core, so to run the binaries you
will need to download and install the .NET Core SDK before you start:
[Download .NET Core
3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1). For now
AElf depends on version 3.1 of the SDK, on the provided link find the
6.0](https://dotnet.microsoft.com/download/dotnet-core/6.0). For now
AElf depends on version 6.0 of the SDK, on the provided link find the
download for your platform, and install it.

Get the latest release with the following commands:
Expand All @@ -228,7 +228,7 @@ packages, but if you want you can compile from source code. First make
sure the code version is consistent (current is release AELF
v1.0.0), and secondly make sure to compile on a Ubuntu Linux
machine (we recommend Ubuntu 18.04.2 LTS) and have dotnet core SDK
version 3.1 installed. This is because different platforms or compilers
version 6.0 installed. This is because different platforms or compilers
will cause the dll hashes to be inconsistent with the current chain.

Check the node
Expand Down