-
Notifications
You must be signed in to change notification settings - Fork 138
Apply renames for the quickstart repo #152
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
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
5010b07
Rename "Quickstarts" folder to "Examples"
EdJoJob 274efd8
Remove instructions for broken Azure Quickstart
EdJoJob 4c8941d
Rename Quickstart tutorials to Example Tutorials
EdJoJob 555914a
Update documentation for rename of repo formerly known as quickstart
EdJoJob 6ab8070
Address feedback and avoid "simple"
EdJoJob e132df8
Keep plurality consistent
EdJoJob b7f7c9f
Use a better synonym
EdJoJob 8dba5af
Use more natural sounding headdings for the example networks
EdJoJob File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,21 @@ | ||
| description: Hyperledger Besu private network with privacy enabled quickstart tutorial | ||
| description: Hyperledger Besu private network with privacy enabled tutorial | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Private Network with Privacy Enabled Quickstart Tutorial | ||
| # Privacy-enabled Private Network Example Tutorial | ||
|
|
||
| The Private Network with Privacy Enabled Quickstart runs a private network of Hyperledger Besu and | ||
| The Private Network with Privacy Enabled Example runs a private network of Hyperledger Besu and | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. again, "Privacy-enabled" |
||
| Orion nodes managed by Docker Compose. | ||
| It is an expanded version of the [Private Network Quickstart](Private-Network-Quickstart.md). | ||
| It is an expanded version of the [Private Network Example](Private-Network-Example.md). | ||
|
|
||
| You can use the [Block Explorer](Private-Network-Quickstart.md#block-explorer), | ||
| make [JSON-RPC requests](Private-Network-Quickstart.md#run-json-rpc-requests), and | ||
| create [transactions using Metamask](Private-Network-Quickstart.md#creating-a-transaction-using-metamask) | ||
| as described in the [Private Network Quickstart tutorial](Private-Network-Quickstart.md). | ||
| You can use the [Block Explorer](Private-Network-Example.md#block-explorer), | ||
| make [JSON-RPC requests](Private-Network-Example.md#run-json-rpc-requests), and | ||
| create [transactions using Metamask](Private-Network-Example.md#creating-a-transaction-using-metamask) | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. comma at the end of the line, to separate from "as described in..." |
||
| as described in the [Private Network Example tutorial](Private-Network-Example.md). | ||
| This tutorial describes how to use the examples provided in the EEAJS library to [create and send private transactions](#send-private-transactions-and-read-values). | ||
|
|
||
| !!! important | ||
| The quickstart runs a private network suitable for education or demonstration purposes. | ||
| The quickstart is not intended for running production networks. | ||
| The sample-network runs a private network suitable for education or demonstration purposes. | ||
| The sample-network is not intended for running production networks. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
|
|
@@ -32,16 +32,16 @@ To run this tutorial, you must have the following installed: | |
|
|
||
| - [Curl command line](https://curl.haxx.se/download.html) | ||
|
|
||
| ## Clone Besu Quickstart Source Code | ||
| ## Clone Besu Sample Networks Source Code | ||
|
|
||
| Clone the repository from the `besu-quickstart` repository. | ||
| Clone the repository from the `besu-` repository. | ||
|
|
||
| ```bash tab="Linux/MacOS" | ||
| git clone https://github.com/PegaSysEng/besu-quickstart.git | ||
| git clone https://github.com/PegaSysEng/besu-sample-networks.git | ||
| ``` | ||
|
|
||
| !!!note | ||
| Download a specific release at https://github.com/PegaSysEng/besu-quickstart/releases. | ||
| To use a specific version of Hyperledger Besu, set the `BESU_VERSION` environment variable. | ||
|
|
||
| ## Clone EEAJS Libraries | ||
|
|
||
|
|
@@ -57,12 +57,12 @@ In the `eeajs` directory: | |
| npm install | ||
| ``` | ||
|
|
||
| ## Start the Private Network with Privacy Enabled | ||
| ## Start the Network | ||
|
|
||
| !!!important | ||
| If running in Windows, please run commands from the GitBash shell | ||
|
|
||
| In the `besu-quickstart` directory, start the network with privacy enabled: | ||
| In the `besu-sample-networks` directory, start the network with privacy enabled: | ||
|
|
||
| ```bash | ||
| ./run-privacy.sh | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we using
Besu Sample Networks(see Log rotation section above) andBesu Example Networksinterchangebly? Suggest standardising on one (Sample Networks probably) if possible.