Refactor/contributor content#126
Conversation
removed CLI Styleguide images to wiki. Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
* updated README * simplified CONTRIBUTING.md * removed unecessary root MD files * Links to Docs Wiki section Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
|
|
||
| ## Useful Links | ||
|
|
||
| * [Besu Docs](http://besu.hyperledger.org/) |
There was a problem hiding this comment.
Use a shared reference-style link here (see for instance https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#links or https://stackoverflow.com/questions/45265914/markdown-what-are-inline-and-reference-style-links)
| ## LF / Jira Accounts | ||
|
|
||
| Having the following accounts is necessary for contributing code/issues to Besu. | ||
| * If you want to contribute code, you can make a [LF foundation account here](#). |
There was a problem hiding this comment.
The F in LF is already for foundation ;)
Maybe always use LF or always Linux Foundation (LF) I don't know, but something user can understand simply (LF is not so easy when you don't know much about the foundations around Besu, HLF, LF... confusing) so maybe use the full word with acronym between parentheses.
There was a problem hiding this comment.
And link is just # it's not going to work.
|
|
||
| Having the following accounts is necessary for contributing code/issues to Besu. | ||
| * If you want to contribute code, you can make a [LF foundation account here](#). | ||
| * If you want to raise an issue, you can login to your [Atlassian account here](https://id.atlassian.com/). |
There was a problem hiding this comment.
not "you can" but "you have to" imo.
| Having the following accounts is necessary for contributing code/issues to Besu. | ||
| * If you want to contribute code, you can make a [LF foundation account here](#). | ||
| * If you want to raise an issue, you can login to your [Atlassian account here](https://id.atlassian.com/). | ||
| * Our Rocket Chat also requires a [LF foundation account](#). |
There was a problem hiding this comment.
# only link not working.
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
* removed rule from link_check_conf.json * deleted docs/community and moved content over to wiki * deleted doc/development and moved content over to wiki Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
|
Could you remove exclude rules on mkdocs.yml for: |
Signed-off-by: Felipe Faraggi <felipefaraggi@gmail.com>
NicolasMassart
left a comment
There was a problem hiding this comment.
just a non vital fix and it's ok for me.
| ## Useful Links | ||
|
|
||
| * [Besu Docs](http://besu.hyperledger.org/) | ||
| * [Besu User Documentation][Besu User Documentation] |
There was a problem hiding this comment.
If the title is the same as the link ref, you don't need to double it ;)
|
And of course links have to work: https://wiki.hyperledger.org/display/BESU/Code-of-conduct returns a 404. |
* Refactor/contributor content (#126) * 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> * Added default data location (#123) * 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> * Moved license note (#129) * 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> * Windows is now supported in the quickstart (#143) Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * quickstart updates all round (#141) * 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> * Fixed typo (#150) * 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. (#131) * 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> * Apply renames for the quickstart repo (#152) * 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 content on protocol upgrades (#132) * 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> * Fixed Ansible link and renamed topic (#168) * 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> * permissioning (#170) 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) Signed-off-by: grantnoble <grant.noble@consensys.net> * updated CI and customised checks (#165) - 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> * Added new NAT options (#179) 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) 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) 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 directory (#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) 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) 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) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * Added plugins_reloadPluginConfig (#184) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * [BESU-163] Add inbound and outbound TLS information. (#124) * 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. (#193) * 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 (#172) * 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> * Editorial mdlint and vale updates in the Concepts/Privacy dir (#183) 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) 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) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * add an info pass for md linting (#205) 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 (#174) * 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> * fix code blocks in doc by updating mkdocs and dependencies (#158) * 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> * Add links to TLS content. (#191) 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 TLS diagram. (#194) 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> * Moved license note (#129) * 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> * Windows is now supported in the quickstart (#143) Signed-off-by: Edward Evans <edward.joshua.evans@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * quickstart updates all round (#141) * 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> * Fixed typo (#150) * 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. (#131) * 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> * Apply renames for the quickstart repo (#152) * 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 content on protocol upgrades (#132) * 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> * Fixed Ansible link and renamed topic (#168) * 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> * updated CI and customised checks (#165) - 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> * Added new NAT options (#179) 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) 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) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * [BESU-163] Add inbound and outbound TLS information. (#124) * 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) 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) 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) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * add an info pass for md linting (#205) 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 links to TLS content. (#191) 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 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 Signed-off-by: grantnoble <grant.noble@consensys.net> * Add Besu Plugin information (#142) * 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 reorg compatible privacy (#192) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * add priv_call API Method (#144) Signed-off-by: grantnoble <grant.noble@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net> * Added tracing API (#182) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * Add Grant as a maintainer (#199) Signed-off-by: Nicolas MASSART <nicolas.massart@consensys.net> Signed-off-by: grantnoble <grant.noble@consensys.net> * Added auto log bloom caching option (#210) Signed-off-by: Madeline Murray <madeline.taylor@gmail.com> Signed-off-by: grantnoble <grant.noble@consensys.net> * A couple of EOL spaces fixed Signed-off-by: grantnoble <grant.noble@consensys.net> * One more minor update Signed-off-by: grantnoble <grant.noble@consensys.net> Co-authored-by: Felipe Faraggi <felipefaraggi@gmail.com> Co-authored-by: MadelineMurray <43356962+MadelineMurray@users.noreply.github.com> Co-authored-by: MadelineAu <40311741+MadelineAu@users.noreply.github.com> Co-authored-by: Edward <edjojob@gmail.com> Co-authored-by: Joshua Fernandes <joshua.fernandes@consensys.net> Co-authored-by: bgravenorst <50852695+bgravenorst@users.noreply.github.com> Co-authored-by: Wesley van Heije <wslyvh@users.noreply.github.com> Co-authored-by: Nicolas MASSART <NicolasMassart@users.noreply.github.com>
PR description
docs contributor content refactor:
Fixed Issue(s)
https://pegasys1.atlassian.net/browse/PIE-1991