-
Notifications
You must be signed in to change notification settings - Fork 138
mdlint and vale editorial edits in the Concepts directory #177
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
MadelineMurray
merged 19 commits into
besu-eth:master
from
grantnoble:grantnoble-concepts-mdlint-vale
Feb 20, 2020
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
1f833dd
Added default data location (#123)
MadelineMurray ede0f66
Moved license note (#129)
MadelineMurray bf29b6e
Windows is now supported in the quickstart (#143)
EdJoJob 263fc6f
quickstart updates all round (#141)
joshuafernandes a42c566
Fixed typo (#150)
MadelineMurray f2b7945
Add multi-tenancy information. (#131)
bgravenorst e8cc3eb
Apply renames for the quickstart repo (#152)
EdJoJob cb65d8b
Added content on protocol upgrades (#132)
MadelineMurray 52e760a
Fixed Ansible link and renamed topic (#168)
MadelineMurray 47444e4
permissioning (#170)
wslyvh 7ebfc27
Vale and mdlint editorial updates - DCO.md (#162)
da817f8
mdlint and vale editorial edits in the Concepts directory
a51b651
Additional vale updates
e8ee8cb
Merge branch 'master' into grantnoble-concepts-mdlint-vale
cefc7ae
Included Protocol-Upgrades.md
97eb3c1
Updates based on @MadelineMurray review
8a8063b
Misc updates based on review feedback
a9d6da8
Merge branch 'master' into grantnoble-concepts-mdlint-vale
12bbc55
Merge branch 'master' into grantnoble-concepts-mdlint-vale
MadelineMurray 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,16 @@ | ||
| description: Alethio Lite Block Explorer And EthStats Lite Network Monitor Overview | ||
| description: Alethio Lite Block Explorer And EthStats Lite Network Monitor overview | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Alethio | ||
|
|
||
| Alethio offers a set of tools including the [Block Explorer](https://aleth.io/) and | ||
| [EthStats Network Monitor](https://ethstats.io/). The Alethio tools are developed by [Alethio](https://company.aleth.io/). | ||
| [Alethio](https://company.aleth.io/) develops a set of tools, including | ||
| [Block Explorer](https://aleth.io/) and [EthStats Network Monitor](https://ethstats.io/), which | ||
| give a comprehensive view into the activity in a public or private Enterprise Ethereum network. | ||
| The statistics are at the network level and the block, transaction, and account level. | ||
|
|
||
| The Block Explorer and EthStats provide a comprehensive view into the activity in a | ||
| public or private Enterprise Ethereum network. The statistics are at the network level | ||
| and the block, transaction, and account level. | ||
| To use Block Explorer and EthStats for testing and private networks, run the the | ||
| [Lite Block Explorer](../HowTo/Deploy/Lite-Block-Explorer.md) and | ||
| [EthStats Lite](../HowTo/Deploy/Lite-Network-Monitor.md). | ||
|
|
||
| To use the Block Explorer and EthStats for testing and private networks, run the the [Lite Block | ||
| Explorer](../HowTo/Deploy/Lite-Block-Explorer.md) and [EthStats Lite](../HowTo/Deploy/Lite-Network-Monitor.md). | ||
|
|
||
| Contact [Alethio](https://company.aleth.io/) at [contact@aleth.io](mailto:contact@aleth.io) for | ||
| details about the full versions and enterprise solutions. | ||
| For more information about the full versions of these products and other enterprise solutions, | ||
| contact [Alethio](https://company.aleth.io/) at [contact@aleth.io](mailto:contact@aleth.io). |
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,11 +1,11 @@ | ||
| description: Hyperledger Besu Architecture | ||
| description: Hyperledger Besu architecture | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Hyperledger Besu Architecture | ||
| # Hyperledger Besu architecture | ||
|
|
||
| The high-level architecture of Hyperledger Besu is: | ||
| The following diagram outlines the Hyperledger Besu high-level architecture. | ||
|
|
||
|  | ||
|
|
||
| If you've got questions about the architecture of Hyperledger Besu, | ||
| contact us on [Hyperledger Besu chat](https://chat.hyperledger.org/channel/besu). | ||
| For more information about the Hyperledger Besu architecture, contact us on | ||
| [Hyperledger Besu chat](https://chat.hyperledger.org/channel/besu). |
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,16 +1,23 @@ | ||
| description: Hyperledger Besu client libraries | ||
| description: Hyperledger Besu client libraries | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Client Libraries | ||
| # Client libraries | ||
|
|
||
| Client libraries such as [web3.js](https://github.com/ethereum/web3.js/), [web3j](https://github.com/web3j/web3j), or [ethereumj](https://github.com/ethereum/ethereumj) are used by Dapps to forward JSON-RPC requests to Hyperledger Besu. Any | ||
| client library that implements core Ethereum RPC methods can be used with Besu. | ||
| Dapps use client libraries, such as [web3.js](https://github.com/ethereum/web3.js/), | ||
| [web3j](https://github.com/web3j/web3j), or [ethereumj](https://github.com/ethereum/ethereumj), to | ||
| forward JSON-RPC requests to Hyperledger Besu. Any client library implementing core Ethereum RPC | ||
| methods works with Besu. | ||
|
|
||
| Use the [web3.js-eea library](../HowTo/Interact/Client-Libraries/eeajs.md) with Besu for [privacy features](../Concepts/Privacy/Privacy-Overview.md). | ||
| Use the [web3.js-eea library](../HowTo/Interact/Client-Libraries/eeajs.md) with Besu for | ||
| [privacy features](../Concepts/Privacy/Privacy-Overview.md). | ||
|
|
||
|  | ||
|
|
||
| Use client libraries to: | ||
|
|
||
| * [create signed transactions](../HowTo/Develop-Dapps/Use-web3js.md) | ||
| * [create and send private transactions](../HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md). | ||
| * [Create signed transactions](../HowTo/Develop-Dapps/Use-web3js.md) | ||
| * [Create and send private transactions]. | ||
|
|
||
| <!-- Links --> | ||
| [Create and send private transactions]: ../HowTo/Send-Transactions/Creating-Sending-Private-Transactions.md | ||
|
|
||
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,9 +1,11 @@ | ||
| description: Mining overview | ||
| <!--- END of page meta data --> | ||
|
|
||
| Hyperledger Besu supports CPU and GPU mining which are [configured using command line options](../HowTo/Configure/Configure-Mining.md). | ||
| Hyperledger Besu supports CPU and GPU mining, which are | ||
| [configured using command line options](../HowTo/Configure/Configure-Mining.md). | ||
|
|
||
| Besu supports GPU mining and has been tested using [Ethminer](https://github.com/ethereum-mining/ethminer) with the `stratum+tcp` and `getwork` schemes. | ||
| GPU mining support testing used [Ethminer](https://github.com/ethereum-mining/ethminer) with | ||
| the `stratum+tcp` and `getwork` schemes. | ||
|
|
||
| !!! note | ||
| The `getwork` scheme is supported as the `http` scheme in certain mining software. | ||
| Some mining software supports the `getwork` scheme as the `http` scheme. |
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,12 +1,14 @@ | ||
| description: Monitoring using metrics and logging | ||
| description: Monitoring using metrics and logging | ||
| <!--- END of page meta data --> | ||
|
|
||
| # Monitoring | ||
| # Monitoring | ||
|
|
||
| Monitoring enables identification of node and network issues. Specifically, configuring metrics and logging enables: | ||
| Monitoring enables identification of node and network issues. Specifically, configuring metrics and | ||
| logging enables: | ||
|
|
||
| * [Visual representation of declining node or network performance](../HowTo/Monitor/Metrics.md) | ||
| * [Collection of log files to enable issue diagnosis](../HowTo/Monitor/Logging.md). | ||
| * [Visual representation of declining node or network performance](../HowTo/Monitor/Metrics.md) | ||
| * [Collection of log files to enable issue diagnosis](../HowTo/Monitor/Logging.md). | ||
|
|
||
| [This recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be) gives an overview of monitoring Hyperledger Besu. | ||
| For an overview of monitoring Hyperledger Besu, view | ||
| [this recording](https://www.youtube.com/watch?v=7BuutRe0I28&feature=youtu.be). | ||
|
|
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.
Assuming this link displays OK when built locally? I normally put them right next to the linked text so not sure of the syntax.
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.
This is a case where the link exceeds 100 characters. As per Nico's suggestion (and I didn't know this until he suggested it), this is valid markdown syntax for constructing links.
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.
Yep, the link is fine when built locally.