github.com/ConsenSys/Quorum@v20.10.0+incompatible/mkdocs.yml (about)

     1  # Project information
     2  site_name: Quorum
     3  site_url: https://docs.goquorum.com/
     4  site_description: A permissioned implementation of Ethereum supporting data privacy
     5  site_author: Quorum
     6  copyright: Quorum 2019
     7  
     8  # Repository
     9  repo_name: quorum
    10  repo_url: https://github.com/jpmorganchase/quorum
    11  
    12  nav:
    13      - Home: index.md
    14      - Getting Started:
    15          - Quickstart: Getting Started/Getting Started Overview.md
    16          - Installing: Getting Started/Installing.md
    17          - Examples: Getting Started/Quorum-Examples.md
    18          - Creating a Network From Scratch: Getting Started/Creating-A-Network-From-Scratch.md
    19          - Running Quorum: Getting Started/running.md
    20          - Quorum API: Getting Started/api.md
    21          - Quorum GraphQL: Getting Started/graphql.md
    22          - Migration: Getting Started/migration.md
    23      - Quorum Features:
    24          - Transaction/Contract Privacy:
    25              - Overview: Privacy/Overview.md
    26              - Privacy/Privacy-Manager.md
    27              - Privacy/Lifecycle-of-a-private-transaction.md
    28              - Tessera:
    29                  - What is Tessera: Privacy/Tessera/Tessera.md
    30                  - Configuration:
    31                      - Overview: Privacy/Tessera/Configuration/Configuration Overview.md
    32                      - Keys Config: Privacy/Tessera/Configuration/Keys.md
    33                      - TLS Config: Privacy/Tessera/Configuration/TLS.md
    34                      - Using CLI to override config: Privacy/Tessera/Configuration/Using CLI to override config.md
    35                      - Sample Configuration: Privacy/Tessera/Configuration/Sample Configuration.md
    36                  - Tessera Services:
    37                      - Transaction Manager: Privacy/Tessera/Tessera Services/Transaction Manager.md
    38                      - Enclave: Privacy/Tessera/Tessera Services/Enclave.md
    39                      - Keys:
    40                          - Key Generation: Privacy/Tessera/Tessera Services/Keys/Keys.md
    41                          - Setting up Hashicorp Vault: Privacy/Tessera/Tessera Services/Keys/Setting up a Hashicorp Vault.md
    42                          - Setting up Azure Key Vault: Privacy/Tessera/Tessera Services/Keys/Setting up an Azure Key Vault.md
    43                          - Setting up AWS Secrets Manager: Privacy/Tessera/Tessera Services/Keys/Setting up an AWS Secrets Manager.md
    44                  - Usage:
    45                      - Interfaces & API: Privacy/Tessera/Usage/Interface & API.md
    46                      - Admin Usage: Privacy/Tessera/Usage/Admin Usage.md
    47                      - Monitoring: Privacy/Tessera/Usage/Monitoring.md
    48                      - Logging: Privacy/Tessera/Usage/Logging.md
    49                  - Migration from Constellation: Privacy/Tessera/Migration from Constellation.md
    50              - Constellation:
    51                  - What is Constellation: Privacy/Constellation/Constellation.md
    52                  - How it works: Privacy/Constellation/How constellation works.md
    53                  - Sample Configuration: Privacy/Constellation/Sample Configuration.md
    54                  - Running Constellation: Privacy/Constellation/Installation & Running.md
    55              - Contract Extension:
    56                  - Overview: Privacy/Contract-Extension/Overview.md
    57                  - APIs: Privacy/Contract-Extension/ContractExtension apis.md
    58          - Consensus:
    59              - Consensus: Consensus/Consensus.md
    60              - Raft BFT:
    61                  - Consensus/raft/raft.md
    62                  - Consensus/raft/raft-rpc-api.md
    63              - Istanbul BFT:
    64                  - Overview: Consensus/ibft/ibft.md
    65                  - Consensus/ibft/istanbul-rpc-api.md
    66                  - Consensus/ibft/ibft-parameters.md
    67          - Permissioning:
    68              - Overview: Permissioning/Permissions Overview.md
    69              - Basic: Permissioning/Basic NetworkPermissions.md
    70              - Enhanced:
    71                - Overview: Permissioning/Enhanced Permissions Model/Overview.md
    72                - Design: Permissioning/Enhanced Permissions Model/Contract Design.md
    73                - Setup: Permissioning/Enhanced Permissions Model/setup.md
    74                - APIs: Permissioning/Enhanced Permissions Model/Permissioning apis.md
    75                - Usage: Permissioning/Enhanced Permissions Model/Usage.md
    76          - Account/Key Management:
    77              - Overview: Account-Key-Management/Overview.md
    78              - Quorum:
    79                  - Overview: Account-Key-Management/Quorum/Overview.md
    80                  - Keystore Files: Account-Key-Management/Quorum/Keystore-Files.md
    81                  - Clef: Account-Key-Management/Quorum/Clef.md
    82                  - account Plugins:
    83                    - Overview: Account-Key-Management/Quorum/account-Plugins/Overview.md
    84                    - Hashicorp Vault:
    85                      - Overview: Account-Key-Management/Quorum/account-Plugins/Hashicorp-Vault/Overview.md
    86                      - Quickstart: Account-Key-Management/Quorum/account-Plugins/Hashicorp-Vault/Quickstart.md
    87              - Tessera: Account-Key-Management/Tessera/Overview.md
    88              - Constellation: Account-Key-Management/Constellation/Overview.md
    89          - Pluggable Architecture:
    90              - Overview: PluggableArchitecture/Overview.md
    91              - Settings: PluggableArchitecture/Settings.md
    92              - Internals: PluggableArchitecture/Internals.md
    93              - Plugins:
    94                  - helloworld:
    95                      - Interface: PluggableArchitecture/Plugins/helloworld/interface.md
    96                      - Implementation: PluggableArchitecture/Plugins/helloworld/implementation.md
    97                  - security:
    98                      - For Users: PluggableArchitecture/Plugins/security/For-Users.md
    99                      - For Developers: PluggableArchitecture/Plugins/security/For-Developers.md
   100                      - API: PluggableArchitecture/Plugins/security/interface.md
   101                  - account:
   102                      - For Users: PluggableArchitecture/Plugins/account/For-Users.md
   103                      - For Developers: PluggableArchitecture/Plugins/account/For-Developers.md
   104                      - API: PluggableArchitecture/Plugins/account/interface.md
   105              - Plugin Development: PluggableArchitecture/PluginDevelopment.md
   106          - DNS: Quorum Features/dns.md
   107          - Securing JSON RPC: Quorum Features/rpc-security.md
   108      - Quorum Projects:
   109          - Quorum Wizard:
   110              - Getting Started: Wizard/GettingStarted.md
   111              - Interacting with the Network: Wizard/Interacting.md
   112          - Cakeshop:
   113              - Overview: Cakeshop/Overview.md
   114              - Getting Started: Cakeshop/Getting started.md
   115              - Cakeshop FAQ: Cakeshop/Cakeshop FAQ.md
   116          - Quorum Profiling: 
   117              - Overview: Quorum Profiling/Overview.md
   118          - Remix Plugin:
   119              - Overview: RemixPlugin/Overview.md
   120              - Getting Started: RemixPlugin/GettingStarted.md
   121          - quorum.js:
   122              - Overview: quorum.js/Overview.md
   123              - extend API: quorum.js/extend.md
   124              - RawTransactionManager API: quorum.js/RawTransactionManager.md
   125      - Security Framework:
   126            - Overview: Security/Framework/Overview.md
   127            - Quorum Network:
   128              - Consortium: Security/Framework/Quorum Network Security/Consortium.md
   129              - Quorum Node: Security/Framework/Quorum Network Security/Node.md
   130              - Transaction Manager: Security/Framework/Quorum Network Security/Transaction Manager.md
   131              - Operational Considerations: Security/Framework/Quorum Network Security/Opertional Considerations.md
   132            - Decentralized App:
   133              - Frontend: Security/Framework/Decentralized Application/Frontend Components.md
   134              - Smart Contracts:  Security/Framework/Decentralized Application/Smart Contracts Security.md
   135      - How-To Guides:
   136          - Adding new nodes: How-To-Guides/adding_nodes.md
   137          - Adding IBFT validators: How-To-Guides/add_ibft_validator.md
   138          - Backup & Restore: How-To-Guides/import-export.md
   139          - Quorum/Tessera HA Setup: How-To-Guides/HA_Setup.md
   140      - Product Roadmap: roadmap.md
   141      - FAQ: FAQ.md
   142  
   143  theme:
   144    name: 'material'
   145    custom_dir: 'docs/theme'
   146    font:
   147        text: 'Roboto'
   148        code: 'Roboto Mono'
   149    language: 'en'
   150    logo: 'images/logo.png'
   151    favicon: 'images/logo-48x48.png'
   152  
   153  extra_css:
   154      - 'theme/assets/stylesheets/extra.css'
   155  
   156  markdown_extensions:
   157      - toc:
   158          permalink: true
   159          toc_depth: 3
   160      - attr_list
   161      - codehilite
   162      - admonition
   163      - footnotes
   164      - def_list
   165      - abbr
   166      - pymdownx.arithmatex
   167      - pymdownx.betterem:
   168            smart_enable: all
   169      - pymdownx.keys
   170      - pymdownx.details
   171      - pymdownx.emoji
   172      - pymdownx.magiclink
   173      - pymdownx.mark
   174      - pymdownx.smartsymbols
   175      - pymdownx.superfences
   176      - pymdownx.tasklist:
   177            custom_checkbox: true
   178      - pymdownx.tilde
   179      - markdown_include.include:
   180          base_path: docs
   181      - meta
   182      - smarty
   183      - plantuml_markdown:
   184          server: http://www.plantuml.com/plantuml
   185  
   186  plugins:
   187      - search