Skip to content

Editorial mdlint and vale updates in Develop/Dapps directory#208

Merged
grantnoble merged 64 commits into
besu-eth:masterfrom
grantnoble:grantnoble-develop-dapps-mdlint-vale
Mar 1, 2020
Merged

Editorial mdlint and vale updates in Develop/Dapps directory#208
grantnoble merged 64 commits into
besu-eth:masterfrom
grantnoble:grantnoble-develop-dapps-mdlint-vale

Conversation

@grantnoble
Copy link
Copy Markdown

@grantnoble grantnoble commented Feb 26, 2020

The usual mdlint and vale updates, like line length, eol spaces, sentence case headings, blank lines before and after headings and lists.

NicolasMassart
NicolasMassart reviewed Feb 26, 2020
View reviewed changes
Comment thread docs/HowTo/Develop-Dapps/Use-web3js.md Outdated
Do not use the accounts in the examples on mainnet or any public network except for testing.
The private keys are displayed which means the accounts are not secure.
They display the private keys, which means the accounts are not secure.

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.

./docs/HowTo/Develop-Dapps/Use-web3js.md:17: MD009 Trailing spaces
line number 17 is missleading as the spaces are really on the line 18.

Copy link
Copy Markdown
Author

@grantnoble grantnoble Feb 26, 2020

Choose a reason for hiding this comment

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

I could have sworn I fixed those before. hmmmm. Fixed now.

Comment thread docs/HowTo/Develop-Dapps/Use-web3js.md Outdated
offline, or use [EthSigner](https://docs.ethsigner.pegasys.tech/) to isolate your private keys
and sign transactions with
[`eth_sendTransaction`](https://docs.ethsigner.pegasys.tech/Using-EthSigner/Using-EthSigner/#eth_sendtransaction).

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.

Same here for ./docs/HowTo/Develop-Dapps/Use-web3js.md:26: MD009 Trailing spaces where the spaces are on line 27.
You can configure your IDE to trim spaces even on blank lines automatically or use a regex to search and replace trailing spaces: [ ]+$ will well work to detect all extra spaces at the end of a line.

It will also fix ./docs/HowTo/Develop-Dapps/Use-web3js.md:27: MD022 Headers should be surrounded by blank lines as the spaces are not considered as a blank line.

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.

Fixed.

@NicolasMassart
Copy link
Copy Markdown
Contributor

NicolasMassart commented Feb 26, 2020

@grantnoble don't hesitate to check if the path of the files you edited are present in the checks output artifacts. For instance in https://app.circleci.com/jobs/github/hyperledger/besu-docs/4102/artifacts you can find 3 errors in lintchecker.out that must be solved. I put the comments on the right line changes in this PR so you don't have to search for this one.

@grantnoble
Copy link
Copy Markdown
Author

grantnoble commented Feb 26, 2020

Yes, I am checking the output artefacts after my changes to make sure I haven't left a small thing behind. And like I said in my previous comment, I specifically remember these two edits I missed, and I thought I had up updated them. Perhaps I just imagined that I made the change. :-)

faraggi and others added 24 commits February 27, 2020 09:52
@faraggi
Refactor/contributor content (#126)
e07eef9 
* removed CLI Styleguide images to wiki.
* docs contributor content refactor:
* updated README
* simplified CONTRIBUTING.md
* removed unecessary root MD files
* Links to Docs Wiki section
* added removed image file + url link unification
* LF wording and links
* wording improvement
* removed rule from link_check_conf.json
* deleted docs/community and moved content over to wiki
* formatting and contributing wiki link
* small typo and config update
* fixed links

Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray @MadelineAu
Added default data location (#123)
7e8f125 
* Added default data location

Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>

* Added links

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
Moved license note (#129)
7f65eba 
* Added default data location

Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>

* Moved licence note

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>
@EdJoJob
Windows is now supported in the quickstart (#143)
ed9f892 
Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@joshuafernandes
quickstart updates all round (#141)
c557aa6 
* 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)
bceab84 
* 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)
911f834 
* 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)
450fa9d 
* 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)
f2f8512 
* 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)
e6e523b 
* 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)
90a242d 
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)
d39c52c 
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
updated CI and customised checks (#165)
df5cfd8 
- 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)
3834884 
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)
a458260 
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)
bd07077 
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…
bac6f80 
…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)
eab1155 
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)
56fa882 
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)
a8e3e32 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray
Added plugins_reloadPluginConfig (#184)
2d6e01c 
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)
37fb5f4 
* 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)
49d696c 
* 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)
79f8652 
* 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 and others added 23 commits February 27, 2020 10:29
@MadelineMurray @MadelineAu
Fixed Ansible link and renamed topic (#168)
522854d 
* 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>
@NicolasMassart
updated CI and customised checks (#165)
4c6bd49 
- 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)
6eae848 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
Editorial mklint and vale updates in Concepts/Permissioning dir (#181)
7526654 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
mdlint and vale editorial edits in the Concepts directory (#177)
ab00f15 
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)
66a8fe8 
* 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>
Editorial mdlint and vale updates in the Concepts/Privacy dir (#183)
28106e5 
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)
02e0f6b 
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)
c3c35bb 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
add an info pass for md linting (#205)
f23506b 
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>
@bgravenorst @NicolasMassart
Add links to TLS content. (#191)
05bc6d9 
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>
Editorial mdlint and vale updates in Develop/Dapps directory
46a18bb 
The usual mdlint and vale updates, like line length, eol spaces, sentence case headings, blank lines before and after headings and lists.

Signed-off-by: grantnoble <grant.noble@consensys.net>
minor update
8427b24 
Signed-off-by: grantnoble <grant.noble@consensys.net>
@bgravenorst
Add Besu Plugin information (#142)
72cf7e4 
* 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)
ea1fe38 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
add priv_call API Method (#144)
094ce6e 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@MadelineMurray
Added tracing API (#182)
3e7b5c5 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
@NicolasMassart
Add Grant as a maintainer (#199)
84e174a 
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)
6a4582b 
Signed-off-by: Madeline Murray <madeline.taylor@gmail.com>
Signed-off-by: grantnoble <grant.noble@consensys.net>
A couple of EOL spaces fixed
a9ec8d6 
Signed-off-by: grantnoble <grant.noble@consensys.net>
One more minor update
40857b0 
Signed-off-by: grantnoble <grant.noble@consensys.net>
Merge branch 'master' into grantnoble-develop-dapps-mdlint-vale
680f3ad
Merge branch 'master' into grantnoble-develop-dapps-mdlint-vale
3ec2930
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 self-assigned this Feb 28, 2020
@grantnoble grantnoble merged commit bfe9ae7 into besu-eth:master Mar 1, 2020
@grantnoble grantnoble deleted the grantnoble-develop-dapps-mdlint-vale branch March 2, 2020 01:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@MadelineMurray MadelineMurray Awaiting requested review from MadelineMurray

@bgravenorst bgravenorst Awaiting requested review from bgravenorst

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.

8 participants

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