Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

move overviews to index pages #202

Merged
merged 5 commits into from
Mar 10, 2022
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/account-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ of a public key and a private key. The public key can be shared freely, but **th
* GoQuorum derives the account address from the public key by taking the last 20 bytes of its keccak256 hash
* The Privacy Manager uses the public key as an identifier for the target nodes of a private transaction (that is the `privateFor` transaction field)

Key management determines how [GoQuorum](../develop/manage-keys/managing-keys.md) and [Tessera]({{ extra.othersites.tessera }})
Key management determines how [GoQuorum](../develop/manage-keys/index.md) and [Tessera]({{ extra.othersites.tessera }})
store and use private keys.
2 changes: 1 addition & 1 deletion docs/concepts/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ GoQuorum includes the following changes to geth:
* The P2P layer is changed to only allow connections between [permissioned](permissions-overview.md) nodes.
* The block generation logic is changed to replace the `global state root` check with a `global public state root` check.
* The block validation logic is changed to replace the `global state root` in the block header with the `global public state root`.
* The State Patricia trie is split into two: [a public state trie and a private state trie](privacy/privacy.md#public-and-private-state).
* The State Patricia trie is split into two: [a public state trie and a private state trie](privacy/index.md#public-and-private-state).
* Block validation logic is changed to handle [private transactions](privacy/private-and-public.md#private-transactions).
* Transaction creation is changed to allow for replacing transaction data with encrypted hashes to preserve private data
where required.
Expand Down
4 changes: 3 additions & 1 deletion docs/concepts/blockchain-basics/blockchain-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: What are the various parts of a Blockchain

# Blockchain components

This section introduces the components of [blockchains](index.md).

## Nodes

Blockchains are decentralized, which means that they store data across a network of members who collaborate to monitor
Expand Down Expand Up @@ -52,7 +54,7 @@ access the network.

## Privacy

In a blockchain network, [*privacy*](../privacy/privacy.md) refers to
In a blockchain network, [*privacy*](../privacy/index.md) refers to
the ability to keep transactions private between the involved participants.
Often in a consortium network, some of the participants prefer to restrict how much information they share or who they
transact with.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
description: Blockchain Introduction
---

# Blockchain introduction
# Blockchain basics

This section introduces the concept of a blockchain.
Learn more about [blockchain components](blockchain-components.md).

## What is a blockchain?

Expand Down
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/concepts/privacy/privacy-marker-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can use privacy marker transactions (PMTs) instead of [normal private transa

PMTs are public transactions.
PMTs each have a corresponding [internal private transaction](#internal-private-transaction) stored in the
[private transaction manager](privacy.md#private-transaction-manager) (Tessera) and only available to participants.
[private transaction manager](index.md#private-transaction-manager) (Tessera) and only available to participants.

The advantages of using a PMT over a normal private transaction are:

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/privacy/private-and-public.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ GoQuorum achieves transaction privacy by:
- Enabling transaction senders to create private transactions by marking who is privy to a transaction via the
`privateFor` parameter.
- Storing encrypted private data off-chain in a separate component called the
[private transaction manager](privacy.md#private-transaction-manager).
[private transaction manager](index.md#private-transaction-manager).
The private transaction manager encrypts private data, distributes the encrypted data to other parties that are privy
to the transaction, and returns the decrypted payload to those parties.
- Replacing the payload of a private transaction with a key for the location of the encrypted payload, such that the
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/security-framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ They require governance structures that fulfill the concerns of participants equ

### Security checklist

- Use a [Byzantine fault tolerant consensus protocol](consensus/overview.md) in case nodes are managed by non-trusted participants.
- Use a [Byzantine fault tolerant consensus protocol](consensus/index.md) in case nodes are managed by non-trusted participants.
- Ensure consortium members provide a reasonable network service-level agreement (SLA).
- Ensure private and public payload data is stored in an appropriate geographical legislation area.
- Document:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Configure the private transaction manager

You can configure a connection to the
[private transaction manager](../../concepts/privacy/privacy.md#private-transaction-manager) and enable private
[private transaction manager](../../concepts/privacy/index.md#private-transaction-manager) and enable private
transactions using any of the following methods.

* [Direct IPC connection configuration](#direct-ipc-connection-configuration)
Expand Down Expand Up @@ -172,9 +172,9 @@ HTTP using TLS requires:

```bash
geth <other parameters> \
--ptm.url "https://127.0.0.1:9101" \
--ptm.tls.mode "strict" \
--ptm.tls.rootca "path/to/certfile.pem,dir/with/cert/files/" \
--ptm.tls.clientcert "path/to/client.cert.pem" \
--ptm.tls.clientkey "path/to/client.key.pem" \
--ptm.url "https://127.0.0.1:9101" \
--ptm.tls.mode "strict" \
--ptm.tls.rootca "path/to/certfile.pem,dir/with/cert/files/" \
--ptm.tls.clientcert "path/to/client.cert.pem" \
--ptm.tls.clientkey "path/to/client.key.pem" \
```
6 changes: 3 additions & 3 deletions docs/configure-and-manage/monitor/elastic-stack.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Using Elastic Stack (ELK) with GoQuorum
# Elastic Stack

[Elastic Stack] (ELK) is an open-source log management platform that is available when using the
[Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/getting-started.md).
[Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/index.md).

The [Filebeat] configuration ingests logs and the [Metricbeat] configuration collects metrics from the nodes at regular
defined intervals and outputs them to Redis for storage.
Expand All @@ -22,9 +22,9 @@ The [pipeline configuration] defines the JSON format used for GoQuorum logs and
To view the GoQuorum Quickstart network logs in Kibana:

1. [Start the Quorum Developer Quickstart with GoQuorum](../../tutorials/quorum-dev-quickstart/using-the-quickstart.md),
selecting ELK monitoring.
selecting ELK monitoring.
1. Open the [`Kibana logs address`](http://localhost:5601/app/kibana#/discover) listed by the sample networks `list.sh` script.
The logs display in Kibana.
The logs display in Kibana.

![Kibana](../../images/KibanaQuickstart.png)

Expand Down
6 changes: 3 additions & 3 deletions docs/configure-and-manage/monitor/quorum-reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Using Quorum Reporting tool

[Quorum Reporting](https://github.com/ConsenSys/quorum-reporting) is a tool that provides APIs for generating reports
about contracts deployed to your GoQuorum network.
You can access Quorum Reporting when using the [Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/getting-started.md)
You can access Quorum Reporting when using the [Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/index.md)
or by following the instructions on the repository [README](https://github.com/ConsenSys/quorum-reporting#readme).

Once a contract is registered, you can use Quorum Reporting to inspect the transactions related to that contract and see
Expand All @@ -15,8 +15,8 @@ how the state of the contract has changed over time.
To access Quorum Reporting for your GoQuorum Quickstart network:

1. [Start the Quorum Developer Quickstart with GoQuorum](../../tutorials/quorum-dev-quickstart/using-the-quickstart.md),
selecting default monitoring.
selecting default monitoring.
1. Open the Reporting UI at [`http://localhost:3000`](http://localhost:3000).
The RPC API runs at [`http://localhost:4000`](http://localhost:4000).
The RPC API runs at [`http://localhost:4000`](http://localhost:4000).

![Reporting Tool](../../images/reporting2.png)
4 changes: 2 additions & 2 deletions docs/configure-and-manage/monitor/splunk.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Using Splunk with GoQuorum
# Splunk

[Splunk](https://splunkbase.splunk.com/app/4866/#/details) is a third-party monitoring solution that is available when
using the [Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/getting-started.md).
using the [Quorum Developer Quickstart](../../tutorials/quorum-dev-quickstart/index.md).

If you add Splunk to your GoQuorum Quickstart network, all logs will be directed to the local Splunk container.
From there, you can search through the logs, view network metrics, and create custom dashboards with the data that you're
Expand All @@ -14,7 +14,7 @@ interested in.
To view the GoQuorum Quickstart network logs in Splunk:

1. [Start the Quorum Developer Quickstart with GoQuorum](../../tutorials/quorum-dev-quickstart/using-the-quickstart.md),
selecting Splunk monitoring.
selecting Splunk monitoring.
1. Open the Splunk UI at [`http://localhost:8000`](http://localhost:8000).

![Splunk](../../images/splunk.png)
2 changes: 1 addition & 1 deletion docs/deploy/deployment-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ The following are examples of Quorum deployments.

For more information about Quorum deployment options, [contact Quorum support](https://consensys.net/quorum/subscription/).

[Get started with GoQuorum](install/getting-started-overview.md).
[Get started with GoQuorum](install/index.md).
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
description: Getting started with GoQuorum overview
description: Install GoQuorum overview
---

# Getting started overview
# Installation overview

You can get started with GoQuorum in multiple ways.
They range from using the quickstart to generate a local network, to creating and configuring a full network from scratch.
Expand Down Expand Up @@ -47,7 +47,7 @@ use a cloud service (for example Google GKE, Azure AKS, AWS EKS) or a self-hoste

## Creating a network from scratch

Follow the step-by-step walk-throughs to create and configure GoQuorum networks for [IBFT](../../tutorials/private-network/create-ibft-network.md), [QBFT](../../tutorials/private-network/create-qbft-network.md), and [Raft](../../tutorials/private-network/create-a-raft-network.md) consensus.
Follow the step-by-step walk-throughs to create and configure GoQuorum networks for [QBFT](../../tutorials/private-network/create-qbft-network.md), [IBFT](../../tutorials/private-network/create-ibft-network.md), and [Raft](../../tutorials/private-network/create-a-raft-network.md) consensus.
It also shows how to enable privacy and add/remove nodes as required.

## Creating a network deployed in the cloud
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy/install/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ Use the [reference implementations](https://github.com/ConsenSys/quorum-Kubernet
Kubernetes (K8S). The repository has full support for cloud providers like AWS, Azure, GCP, and IBM, and has production
setups that use of identities and cloud-native secret storage services like Azure KeyVault and AWS Secrets Manager.

Refer to the [tutorial](../../tutorials/kubernetes/overview.md) and familiarize yourself with the reference
Refer to the [tutorial](../../tutorials/kubernetes/index.md) and familiarize yourself with the reference
implementations, and customize them to your requirements.
2 changes: 1 addition & 1 deletion docs/develop/connecting-to-a-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: connecting to a node

Set up a GoQuorum network using one of the following tutorials:

* The [Quorum Developer Quickstart](../tutorials/quorum-dev-quickstart/getting-started.md)
* The [Quorum Developer Quickstart](../tutorials/quorum-dev-quickstart/index.md)
* [Create a private network](../tutorials/private-network/create-ibft-network.md)
* [Create a privacy-enabled network](../tutorials/create-privacy-enabled-network.md)

Expand Down
10 changes: 10 additions & 0 deletions docs/develop/manage-keys/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Manage keys

Options for managing keys in GoQuorum include:

* [`keystore` files](https://geth.ethereum.org/docs/interface/managing-your-accounts) - As with `geth`, you can store
keys in password-protected `keystore` files.
* [`clef`](clef.md) - Introduced in GoQuorum v2.6.0, `clef` runs as a standalone process that increases flexibility and
security by handling GoQuorum's account management responsibilities.
* [`account` plugins](account-plugins.md) - Introduced in GoQuorum v2.7.0, `account` plugins allow you to extend
GoQuorum or `clef` with alternative methods of managing accounts.
15 changes: 0 additions & 15 deletions docs/develop/manage-keys/managing-keys.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/develop/smart-contracts-transactions.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Dapps are built on a decentralized network (Ethereum) and interact with smart co
They can be thought of as a GUI (front end) for a smart contract (back end), and can be written in any language (for example,
JavaScript).

If using the [Quorum Developer Quickstart](../tutorials/quorum-dev-quickstart/getting-started.md), or
If using the [Quorum Developer Quickstart](../tutorials/quorum-dev-quickstart/index.md), or
existing blockchain, you can use a demo dapp called [Pet Shop](https://docs.goquorum.consensys.net/en/latest/Tutorials/Quorum-Dev-Quickstart/Using-the-Quickstart/#smart-contract-and-dapp-usage),
provided by [Truffle](https://trufflesuite.com/tutorial).

Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ hide:
- navigation

profiles:
- link: deploy/install/getting-started-overview/
- link: deploy/install/
title: Deploy GoQuorum
text: Install GoQuorum or upgrade from an earlier version.
Run the Quorum Developer Quickstart to set up a local development environment.
Expand All @@ -28,12 +28,12 @@ profiles:
applications for the GoQuorum network.
image: assets/illustrations/undraw_web_development_0l6v.svg

- link: concepts/blockchain-basics/what-is-blockchain/
- link: concepts/blockchain-basics/
title: Learn about GoQuorum
text: Read about blockchain concepts and GoQuorum architecture and features.
image: assets/illustrations/undraw_knowledge_g-5-gf.svg

- link: tutorials/quorum-dev-quickstart/getting-started/
- link: tutorials/quorum-dev-quickstart/
title: Try the tutorials
text: Use the Quorum Developer Quickstart, deploy and interact with smart contracts, and create private networks.
image: assets/illustrations/undraw_setup_wizard_re_nday.svg
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api-methods.md
Original file line number Diff line number Diff line change
Expand Up @@ -2468,7 +2468,7 @@ This can only be performed for the master organization and requires the majority

## Privacy methods

The following API methods provide functionality for GoQuorum [privacy](../concepts/privacy/privacy.md).
The following API methods provide functionality for GoQuorum [privacy](../concepts/privacy/index.md).

!!! note

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorials/contracts/account-funds-transfers.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@ description: funds transfer transactions
# Transfer funds between accounts

This tutorial shows you how to transfer funds (ETH) between accounts in a transaction on a running network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/getting-started.md) to rapidly generate a local blockchain network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/index.md) to rapidly generate a local blockchain network.

## Prerequisites

* A private network.
You can use a [private network tutorial](../private-network/create-ibft-network.md) or the
[Quorum Developer Quickstart](../quorum-dev-quickstart/getting-started.md).
[Quorum Developer Quickstart](../quorum-dev-quickstart/index.md).

## Using `eth_sendSignedTransaction`

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/contracts/calling-contract-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: calling smart contracts functions
# Interact with a deployed smart contract

This tutorial shows you how to interact with smart contracts that have been deployed to a network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/getting-started.md) to rapidly generate a local blockchain network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/index.md) to rapidly generate a local blockchain network.

## Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion docs/tutorials/contracts/deploying-contracts.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: deploying smart contracts
# Deploy a smart contract

This tutorial shows you how to deploy smart contracts as transactions onto a running network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/getting-started.md) to rapidly generate a local blockchain network.
Use the [Quorum Developer Quickstart](../quorum-dev-quickstart/index.md) to rapidly generate a local blockchain network.

## Prerequisites

Expand Down
Loading