Skip to content

Editorial mdlint and vale edits for HowTo/Deploy directory#200

Merged
grantnoble merged 50 commits into
besu-eth:masterfrom
grantnoble:grantnoble-howto-deploy-mdlint-vale
Mar 1, 2020
Merged

Editorial mdlint and vale edits for HowTo/Deploy directory#200
grantnoble merged 50 commits into
besu-eth:masterfrom
grantnoble:grantnoble-howto-deploy-mdlint-vale

Conversation

@grantnoble
Copy link
Copy Markdown

@grantnoble grantnoble commented Feb 24, 2020

The ususal mdlint and vale edits

MadelineMurray
MadelineMurray approved these changes Feb 25, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@MadelineMurray MadelineMurray left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couple of comments

Comment thread docs/HowTo/Deploy/Lite-Block-Explorer.md Outdated
data at the block, transaction, and account level.

The Alethio Ethereum Lite Explorer is a web application that connects to any Ethereum
JSON-RPC-enabled node. It does not require an online server, hosting, or trusting third parties to
Copy link
Copy Markdown
Contributor

@MadelineMurray MadelineMurray Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment about it as about this on another PR. Generally, we try and avoid using it because it adds to the cognitive load of the reader. They have to think about it in relation to the previous sentence to understand the meaning. The difficulty increases for ESL readers and for translation.

Could be rewritten as:
The Explorer does not require....

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Comment thread docs/HowTo/Deploy/Lite-Network-Monitor.md Outdated
To run EthStats Lite for a network of nodes, a [client](#3-client) must be started for each node.

This example describes how to run EthStats Lite for a single Besu node. To run EthStats Lite
for a network of nodes, each node requires you to start a [client](#3-client) for each node.
Copy link
Copy Markdown
Contributor

@MadelineMurray MadelineMurray Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having each node twice sounds a little circular - could it be worded differently?

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to:
"Running EthStats Lite for a network requires starting a client for each node in the network."

Copy link
Copy Markdown
Contributor

@NicolasMassart NicolasMassart Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like "Run one dedicated EthStat client for each node on the network to be able to connect to EthStats Lite server"?

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"For a network, run one dedicated EthStats Lite client for each node on the network."

Copy link
Copy Markdown
Contributor

@NicolasMassart NicolasMassart Feb 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perhaps even without he additionnal "network" at the end: "For a network, run one dedicated EthStats Lite client for each Besu node." Maybe specifying what node we talk about for the sentence to be absolutely clear?

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 27, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed, as you suggested @NicolasMassart

@NicolasMassart
Copy link
Copy Markdown
Contributor

NicolasMassart commented Feb 26, 2020

MarkdownLint errors still present on this for the files you changed:

./docs/HowTo/Deploy/Validators.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Bootnodes.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Lite-Network-Monitor.md:26: MD004 Unordered list style
./docs/HowTo/Deploy/Lite-Network-Monitor.md:28: MD004 Unordered list style
./docs/HowTo/Deploy/Lite-Network-Monitor.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Lite-Block-Explorer.md:11: MD002 First header should be a top level header
./docs/HowTo/Deploy/Lite-Block-Explorer.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Kubernetes.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Cloud.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Production.md:1: MD041 First line in file should be a top level header
./docs/HowTo/Deploy/Ansible.md:1: MD041 First line in file should be a top level header

EdJoJob and others added 24 commits February 27, 2020 12:06
@EdJoJob
Windows is now supported in the quickstart (#143)
6a1f20f 
Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@joshuafernandes
quickstart updates all round (#141)
ee650ac 
* 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>
@MadelineMurray @MadelineAu
Fixed typo (#150)
b93cac5 
* 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>
@bgravenorst @MadelineMurray
Add multi-tenancy information. (#131)
a89a555 
* 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>
@EdJoJob
Apply renames for the quickstart repo (#152)
420f1f2 
* 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>
@MadelineMurray @MadelineAu
Added content on protocol upgrades (#132)
fb21049 
* 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>
@MadelineMurray @MadelineAu
Fixed Ansible link and renamed topic (#168)
15d19d6 
* 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>
@wslyvh
permissioning (#170)
e6a50fa 
Signed-off-by: wslyvh <wslyvh@users.noreply.github.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Vale and mdlint editorial updates - DCO.md (#162)
e99e619 
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
updated CI and customised checks (#165)
3133712 
- 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>
@MadelineMurray
Added new NAT options (#179)
2ccc7c0 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mdlint vale updates for Concepts/Transactions directory (#185)
e38cc1c 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mklint and vale updates in Concepts/Permissioning dir (#181)
5e8ba8e 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
mdlint and vale editorial updates in Concepts/Consensus-Protocols dir…
0acfbf1 
…ectory (#180)

Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
mdlint and vale editorial edits in the Concepts directory (#177)
302a85f 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
vale and mklint editorial updates - CONTRIBUTING.md (#163)
e925eb1 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
mdlint and vale editorial updates - index.md (#169)
41e17c2 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray
Added plugins_reloadPluginConfig (#184)
fe09f98 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>

Signed-off-by: grantnoble <grant.noble@consensys.net>
@bgravenorst
[BESU-163] Add inbound and outbound TLS information. (#124)
df318e9 
* 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>
@bgravenorst
Add multi-tenancy whitelist info. (#193)
af00d26 
* 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>
@NicolasMassart
add redirect plugin and initial configuration from RTD redirects (#172)
b237ec2 
* 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>
@MadelineMurray @MadelineAu
Fixed typo (#150)
d9371ab 
* 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>
@MadelineMurray @MadelineAu
Added content on protocol upgrades (#132)
87c37a9 
* 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>
@MadelineMurray @MadelineAu
Fixed Ansible link and renamed topic (#168)
99b7aad 
* 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>
Grant Noble and others added 24 commits February 27, 2020 12:21
mdlint and vale editorial edits in the Concepts directory (#177)
72e2275 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mdlint and vale edits for HowTo/Deploy directory
c288509 
The ususal mdlint and vale edits

Signed-off-by: grantnoble <grant.noble@consensys.net>
A few extra changes
d8c61cc 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mdlint and vale updates in the Concepts/Privacy dir (#183)
9be71f0 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mdlink and vale updates for HowTo/Configure directory (#187)
932379d 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mdlint and vale updates to Howto/Backup directory (#186)
a7861a6 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Updates based on @MadelineMurray feedback
884cc70 
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
add an info pass for md linting (#205)
6043117 
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>
@NicolasMassart
add postman collection locally and fix the postman button style (#174)
ab5dbea 
* 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>
@NicolasMassart
fix code blocks in doc by updating mkdocs and dependencies (#158)
52ee20b 
* 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>
@bgravenorst @NicolasMassart
Add links to TLS content. (#191)
4b20196 
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>
@bgravenorst @NicolasMassart
Add TLS diagram. (#194)
f9b2cee 
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>
Updates based on @NicolasMassart feedback
562d11d 
Signed-off-by: grantnoble <grant.noble@consensys.net>
@bgravenorst
Add Besu Plugin information (#142)
0d3833f 
* 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>
@MadelineMurray
Added reorg compatible privacy (#192)
228d0ab 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
add priv_call API Method (#144)
73ae28d 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray
Added tracing API (#182)
36f71b3 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
Add Grant as a maintainer (#199)
10473ff 
Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray
Added auto log bloom caching option (#210)
0958da0 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Updated EthStats Lite para in Lite-Network-Monitor.md
ed9dc56 
and updated metadata syntax

Signed-off-by: grantnoble <grant.noble@consensys.net>
Added level 1 headers
8fd6595 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Updated unordered list style
fac3369 
Signed-off-by: grantnoble <grant.noble@consensys.net>
List indentation update
692eef9 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Merge branch 'master' into grantnoble-howto-deploy-mdlint-vale
11cb5a4
NicolasMassart
NicolasMassart approved these changes Feb 27, 2020
View reviewed changes
Copy link
Copy Markdown
Contributor

@NicolasMassart NicolasMassart left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@grantnoble grantnoble merged commit e123d47 into besu-eth:master Mar 1, 2020
@grantnoble grantnoble deleted the grantnoble-howto-deploy-mdlint-vale branch March 2, 2020 01:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bgravenorst bgravenorst Awaiting requested review from bgravenorst

@MadelineMurray MadelineMurray Awaiting requested review from MadelineMurray

1 more reviewer

@NicolasMassart NicolasMassart NicolasMassart approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@grantnoble grantnoble

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@grantnoble @NicolasMassart @MadelineMurray @EdJoJob @joshuafernandes @bgravenorst @wslyvh