History

libby kent e01b15e6b4 Adding qubernetes to quorum README.md / docs. (#970 )		2020-04-10 13:57:01 -04:00
..
Cakeshop	Fixes markdown bullet formatting for cakeshop getting started	2020-01-15 15:23:11 -05:00
Consensus	Fix broken raft consensus link (#940 )	2020-02-11 15:22:51 -05:00
Features	Support Quorum import export chain (#946 )	2020-03-02 16:28:40 -05:00
Getting Started	Adding qubernetes to quorum README.md / docs. (#970 )	2020-04-10 13:57:01 -04:00
How-To-Guides	Create tutorial for adding Quorum nodes (#925 )	2020-01-23 13:40:57 -05:00
Permissioning	Updated permissions documentation to remove inactive status for accounts. Modified contract to fix issue with suborg id when node is added to sub orgs (#950 )	2020-03-10 11:08:14 -04:00
PluggableArchitecture	docs: fix broken link (#949 )	2020-03-03 14:06:27 -05:00
Privacy	Merge branch 'master' into docs/AWSSecretsManagerKeyVault	2020-02-10 15:35:15 +00:00
RemixPlugin	Removes .swp file	2019-12-10 15:52:28 -05:00
Security/Framework	fix typo (#930 )	2020-01-29 11:43:12 -05:00
Transaction Processing	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
images	Adding qubernetes to quorum README.md / docs. (#970 )	2020-04-10 13:57:01 -04:00
theme	Add logo favicon and other minor doc fixes/changes: (#723 )	2019-05-23 18:37:52 -04:00
FAQ.md	Updating Compatibility table & adding Quorum 2 geth map (#959 )	2020-03-25 10:46:55 -04:00
Quorum Design.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
Quorum Whitepaper v0.2.pdf	Documentation wording and formatting changes (#492 )	2018-08-24 09:08:02 -04:00
Quorum_Equity_Use_Case.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
README.md	added how-to-contribute (#736 )	2019-06-10 15:25:00 -04:00
ZSL-Quorum-POC_Protocol_v0_4.png	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
ZSL.md	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
conf.py	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
index.md	Quorum documentation update (#701 )	2019-05-02 12:38:58 -04:00
private-abigen.md	Quorum private transaction support for Abigen (#819 )	2019-10-01 12:49:26 -04:00
requirements.txt	Framework that allows adding additional Quorum features as plugins (#923 )	2020-02-28 15:19:08 -05:00
roadmap.md	Docs updates (#735 )	2019-06-10 10:42:20 -04:00

README.md

Quorum documentation

New Quorum documentation is now published on https://docs.goquorum.com/

How to contribute

Quorum documentation files are written in Markdown and configured with a YAML configuration file from mkdocs

The documentation site uses Material theme which has been configured with number of theme extensions to enhance documenting experience

To contribute, here is 3 simple steps

Use Python to install mkdocs and related dependencies
```
pip install -r requirements.txt
```
Add/Modify desired documentation files and preview the site
```
mkdocs serve
```
Commit and raise PR against master