Edit content under Concepts > Multi-tenancy.

Edit for style and consistency, perhaps remove unneeded content. Update and simplify diagram mulit-tenancy diagram to match current docs style.

Doc how to configure GoQuorum using a configuration file

Add some examples in the documentation for sample Quorum deployments

We should also add Quorum Blockchain Service to this.

Add guide on using contract state extension, using the relevant API methods. It may be based off this flow.

quorum.js and web3js-eea deprecation is officially announced for December 31st 2021. From now on we will be supporting web3js-quorum which is basically a merge and refacto of the two former libraries (all commits have been kept) that is compatible with both GoQuorum and Besu.

Some guides and tutorials may need to be updated.

Dev PR: Consensys/quorum#1113

Make clear in the documentation that gas price must be 0 in GoQuorum networks.

Add a recommendation similar to: We do not recommend building from source ideally users should use our official docker images or official binaries.

If building from source however, recommend the version of Go listed in https://github.com/ConsenSys/quorum/blob/master/go.mod.

For context see https://ethereum.stackexchange.com/questions/102594/setup-quorum-blockchain

Slack thread: https://go-quorum.slack.com/archives/C68NY0QQZ/p1605702535133600

It's not clear which monitoring options are the same in Besu and GoQuorum and which are different.

Similar to what's done for the ConsenSys Quorum plugins:
https://docs.quorumplugins.consensys.net/en/stable/Reference/Besu-Plugins/CLI-Syntax/

Add a description and link to GoQuorum Hibernate:

https://github.com/ConsenSys/quorum-hibernate

https://docs.goquorum.consensys.net/en/stable/Reference/GoQuorum-Projects/ should be replaced with a link to https://github.com/ConsenSys/awesome-quorum. The awesome-quorum repo should be updated with the projects from the GoQuorum page. Remove the defunct consistency-checker.

The documentation needs to make it clear that DNS names can be used in the permissioned-node.json / static-nodes.json files.

See:
https://docs.goquorum.consensys.net/en/stable/Concepts/Permissioning/BasicNetworkPermissions/

Perhaps also make it clear in the DNS topic that these files can use DNS names.

For additional context see https://consensys.slack.com/archives/CQ6B7535E/p1623375611013500

Remaining updates include:

• Update the content at the bottom to of the site to include:
  _ConsenSys has acquired Quorum from J.P. Morgan. FAQ available here. Questions or feedback? .... _
• Link to gitter to point to GoQuorum slack or ConsenSys Discord

GoQuroum and Tessera have Slack. Invite link - https://93ecjxb0d3.execute-api.us-east-1.amazonaws.com/Express/

See: https://go-quorum.slack.com/archives/C68NY0QQZ/p1618205859050100

Update: https://docs.goquorum.consensys.net/en/stable/Reference/quorum.js/RawTransactionManager/#externally-signing-and-sending-a-private-tx

With instructions with extra clarification that Step 4 can only happen after signing the transaction, as it needs to modify the v value, which is only present after signing a tx.
For step 5, the extra parameters for submitting a transaction do not relate at all to the transaction itself, so need to submitted alongside the transaction - which means by that point the tx needs to be signed.

Summary

Documentation in the section https://docs.goquorum.consensys.net/en/stable/Concepts/Privacy/PrivateAndPublic/#private-transactions seems that is not right based on the changes done in EIP155.

Expected

It should detail that the V value in the public transaction is selected based on https://github.com/ethereum/EIPs/blob/master/EIPS/eip-155.md if we have that block activated.

Actual

Mentions the original implementation of the Yellow paper, not applied if we are using EIP155: as opposed to 27 or 28 which are the values used to indicate a Transaction is ‘public’ as per standard Ethereum as specified in the Ethereum yellow paper.

Raft is presented as the default option in the GoQuorum docs.  It would be better to mirror the Besu docs and present IBFT/QBFT as the default option and Raft as an alternative.  A page similar to this would help as well - https://besu.hyperledger.org/en/stable/Concepts/Consensus-Protocols/Comparing-PoA/

.circleci/vale.ini has a typo but Vale did not notice it.
Also, Vale was not returning an error code so running with the faulty ini returned 0 (success) and we did not notice it.
Vale latest version fixes this.

Account management with Quorum will be deprecated in the future:

Account management will be deprecated within geth in the future and replaced with clef.

Given this, the existing tutorials should be updated to use the same accounts for testing as Besu (https://besu.hyperledger.org/en/stable/Reference/Accounts-for-Testing/) and the steps to generate keys using Geth removed.

In this discussion: https://go-quorum.slack.com/archives/C68NY0QQZ/p1618912234062800

There is a need, during adding a role for sub organization, to add role with roleId currently existing in UltimateParent organization. This may require clarification.

PR: Consensys/quorum#1072

Update the GoQuorum architecture diagram to match current docs style and edit content on this page as needed. Make sure to update the diagram labels to "GoQuorum."

Users have requested instruction on how to upgrade the Quorum version of existing and running nodes in a network.

See:

• Consensys/quorum#1255
• Consensys/quorum#1267

Inspired by this Discord post: https://discord.com/channels/697535391594446898/725135429623611463/776484394671800370

Edit content under Concepts > Plugins (Overview and Architecture).

Edit for style and consistency, and update and simplify plugins architecture diagram to current docs style.

https://docs.goquorum.consensys.net/en/latest/HowTo/Configure/HighAvailability/#standalone-proxy-server-setup

1. Remove the warning at the top of the page
2. Update the steps to http connection
3. Remove (possibly) the proxy config

See discussion: https://consensys.slack.com/archives/G014F0UAUBY/p1620077907242100

All navigation and page headers should be updated to use sentence-style capitalization.

In the Adding and removing IBFT validators topic, add information about using istanbul.discard to remove a validator candidate from running for the validator role.

Make code samples compliant with https://github.com/ConsenSys/doc.common/wiki/Documentation-Style-Guide#code-samples

Add descriptive flows and maybe diagrams for processing private transactions.

The following content is removed with PR #139 and can be referenced for this PR:

• Private transaction lifecycle
• Privacy marker transaction flows

Also reference Besu's Processing private transactions.

Link to the following regarding the genesis file creation:
https://consensys.net/blog/quorum/hyperledger-besu-how-to-create-an-ethereum-genesis-file/

Check if any of the information should be added to the documentation as well.

The following content requires an edit: https://docs.goquorum.consensys.net/en/latest/Concepts/Privacy/PrivacyMarkerTransactions/

The --privacymarker.enable CLI option may need to be documented as well.

Edit content under Concepts > Security framework.

Edit for style and consistency, perhaps consolidate some pages and reevaluate how much of this content is needed.

Edit GoQuorum pages under Concepts > Privacy.

Edit for style and consistency, remove unnecessary information, update/simplify/remove diagrams for the private transaction lifecycle page and contract state extension as needed.

Edit the GoQuorum content added in this PR: #130

Doc PR: Consensys/quorum#1105

Currently the APIs are on separate pages with inconsistent formatting. They should be combined and edited onto one page, like the Besu APIs.

A GoQuorum Grafana dashboard is now available here: https://grafana.com/grafana/dashboards/14360

Document the --raftlogdir CLI option. See Consensys/quorum#1110

Edit the How to > Develop plugins page for style, grammar, and clarity.

The Developer Quickstart now integrates Splunk, Ethlogger and OpenTelemetry Collector to the quickstart as a separate option from ELK.

See: Consensys/quorum-dev-quickstart#56

The following link 404s: https://docs.goquorum.consensys.net/en/stable/Tutorials/Adding-removing-IBFT-validators/

See: Consensys/quorum#1258

See: Consensys/quorum#1215

The readme.md on the quorum github needs updating due to the reorganisation of the documents.
All the links on the readme still point to docs.goquorum.com, which now redirects to docs.goquorum.consensys.net but not to the correct pages under the docs, so the user sees a page with "Sorry but we can't find the page you asked for".

Note that I've raised this as an issue here since it relates to the docs, but I expect this needs to be fixed on the quorum github.

• Consensys/quorum#1040 - The pages documenting usage of the Hashicorp Vault plugin docs are not migrated over.
• https://docs.goquorum.consensys.net/en/latest/HowTo/ManageKeys/AccountPlugins/#example - Heading level needs fixing to be consistent
• https://docs.goquorum.consensys.net/en/latest/Concepts/Privacy/ContractExtension/#note - Formatting of first element in list is broken. Needs a line spacing (this is also carried over from previous documentation)
• https://docs.goquorum.consensys.net/en/latest/Concepts/Plugins/PluginsArchitecture/#plugin-reloading - link to “HelloWorld plugin example” is not correct. It should be Concepts/Plugins/Plugins/#example-helloworld-plugin Tessera
• Logging documentation PR Consensys/quorum#1013 - Could you created under relevant section and original PR closed.

Once above documentation updates are completed along with Consensys/doc.tessera#9, PR Consensys/quorum#1062 to delete old documentation could be actioned.

Investigate whether some of the Chainstack tutorials should be documented in Quorum and raise appropriate issues for Besu/GoQuorum.

See: https://docs.chainstack.com/operations/quorum/configuring-consensus#get-the-list-of-the-latest-validator-candidate-proposals

Remove FAQ page and make sure every answer is clear from reading the rest of the documentation. Add clarifying content to docs or restructure docs content as needed.

• https://docs.goquorum.consensys.net/en/latest/HowTo/GetStarted/GettingStartedOverview/#goquorum-on-kubernetes
  • change https://github.com/jpmorganchase/qubernetes to https://github.com/ConsenSys/qubernetes
• https://docs.goquorum.consensys.net/en/latest/HowTo/GetStarted/Install/#goquorum
  • Code snippet here shows JPM repo for Quorum and not ConsenSys
• https://docs.goquorum.consensys.net/en/latest/HowTo/GetStarted/Install/#tessera
• https://docs.goquorum.consensys.net/en/latest/HowTo/GetStarted/Install/#as-release-binaries