Editorial mdlint and vale updates for the HowTo/Find-and-Connect directory#209
Merged
grantnoble merged 37 commits intoMar 1, 2020
Conversation
Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* updating the hdwallet provider package * updating json rpc port in the quickstart docs * pr fixes Signed-off-by: Joshua Fernandes <joshua.fernandes@consensys.net> Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Added default data location Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * Fixed typo Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Co-authored-by: MadelineAu <40311741+MadelineAu@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Add multi-tenancy information. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Minor updates. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Implement reviewer feedback. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Update diagram. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Address reviewer feedback. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Co-authored-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Remove instructions for broken Azure Quickstart * Rename Quickstart tutorials to Example Tutorials * Rename references to the repository to be sample-networks Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Added default data location Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * added protocol upgrades content Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * rework Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Co-authored-by: MadelineAu <40311741+MadelineAu@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Added default data location Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * added protocol upgrades content Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * rework Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> * Updated link and changed topic name Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Co-authored-by: MadelineAu <40311741+MadelineAu@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: wslyvh <wslyvh@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
- updated CI config to remove useless DIND -> now directly using the target image with the correct soft installed as it was otherwise not possible to run the jobs locally with Circle CI CLI. - Updated and customised Vale config rules - Updated en customised markdownlint config and rules - moved config files to CI folder - added scripts to run CI jobs locally with Circle CI CLI. Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
…ectory (#180) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* BESU-163: Add inbound TLS information. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Implement reviewer feedback.. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Add privacy CLI options. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Add privact CLI options. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Added privacy CLI commands. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Add Privacy CLI options. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Implement reviewer feedback. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Implement reviewer feedback. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Add multi-tenancy whitelist info. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Minor change to kick off Circle CI build. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
* add redirect plugin and initial configuration from RTD redirects * added redirect for uPnP Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
adding an info pass that's not breaking the build the breaking checks are on another run in the same job two artifacts are now produced line length check is now only in the info pass Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
* add postman collection locally and fix the postman button style fixed the button that is an image and was taken in account for zoom feature. Zoom only works on non link images now. Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> * ignore the link to postman as include prevents the check Ignoring an internal file is ok as soon as we target it in a detailed way to prevent the pattern to accidentally ignore another file. Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> * remove the reference to "our site" as requested by @MadelineMurray Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
* update mkdocs and dependencies to fix code blocks anyway it was a necessary update Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> * trying material 4.6.3 Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com> Signed-off-by: grantnoble <grant.noble@consensys.net>
* Add Besu Plugin information. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Added webinar link. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Address Tech Review comments. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Address review feedback. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> * Add javadoc links. Signed-off-by: Byron Gravenorst <byron.gravenorst@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net>
added 3 commits
February 26, 2020 15:23
…ctory The usual mdlint and vale updates (line lengths, where possible), eol spaces, passive to active voice, etc.) Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
NicolasMassart
approved these changes
Feb 27, 2020
Contributor
NicolasMassart
left a comment
NicolasMassart
left a comment
There was a problem hiding this comment.
a few suggestions but nothing that restrains from merging. Good job, I can't wait for all CI to be green!
| # Bootnodes | ||
|
|
||
| Bootnodes are used to initially discover peers. A bootnode is a regular node a node uses to discover nodes. | ||
| Using Bootnodes is method for initially discovering peers. A bootnode is a regular node a node uses |
Contributor
There was a problem hiding this comment.
Perhaps "Using Bootnodes is a method" or "Using Bootnodes is the method"?
There's a lot of "node" in this sentence, maybe we should try to find a way to reduce as it's a bit hard to understand which node is which. It makes the same effect as using "it" or "this" for different things in the same sentence to me.
Author
There was a problem hiding this comment.
You're right, I definitely missed "a". Reworded as follows:
"Using Bootnodes is a method for initially discovering peers. Bootnodes are regular nodes used to discover other nodes."
| ## MainNet and public testnets | ||
|
|
||
| For MainNet and the Rinkeby, Ropsten, and Görli testnets, Hyperledger Besu predefines a list of | ||
| enode URLs. |
Contributor
There was a problem hiding this comment.
I would add something like "and will automatically use it when you use the --network CLI option."
Author
There was a problem hiding this comment.
Done.
"... Hyperledger Besu predefines a list of enode URLs and uses this list automatically when you specify the
--network option.
|
|
||
| The default host and port for P2P peer discovery is `127.0.0.1:30303`. Use the [`--p2p-host`](../../Reference/CLI/CLI-Syntax.md#p2p-host) | ||
| and [`--p2p-port`](../../Reference/CLI/CLI-Syntax.md#p2p-port) option to specify a host and port. | ||
| The default host and port for P2P peer discovery is `127.0.0.1:30303`. To specify a different host |
Contributor
There was a problem hiding this comment.
I would say "The default host and port advertised to other peers for P2P peer discovery is" as user have to know that this is not the listening host, which is defined in --p2p-interface but really what we advertise to other peers.
|
|
||
| In private networks with a level of trust between peers, enabling the [remote connection limits](../../Reference/CLI/CLI-Syntax.md#remote-connections-limit-enabled) | ||
| is unnecessary and disabling may increase the speed at which nodes can join the network. | ||
| In private networks with a level of trust between peers, enabling the |
Contributor
There was a problem hiding this comment.
no fix to do here in this PR, but can we create a ticket to say that maybe we should add the info about why limiting remote connections and not only when not limiting?
| [`--p2p-port`](../../Reference/CLI/CLI-Syntax.md#p2p-port), | ||
| [`--rpc-http-host`](../../Reference/CLI/CLI-Syntax.md#rpc-http-host), and | ||
| [`--rpc-http-port`](../../Reference/CLI/CLI-Syntax.md#rpc-http-port) options, with the default | ||
| values advertised instead. No newline at end of file |
Contributor
There was a problem hiding this comment.
"and the default
values are advertised instead." ?
Author
There was a problem hiding this comment.
Broke it up into two sentences.
"... options. Besu advertises the default values instead."
added 2 commits
February 27, 2020 21:35
Signed-off-by: grantnoble <grant.noble@consensys.net>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
7 participants
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.
The usual mdlint and vale updates (line lengths, where possible), eol spaces, passive to active voice, etc.)