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

docusaurus 3 #273

Merged
merged 6 commits into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all 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
91 changes: 10 additions & 81 deletions .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,88 +1,17 @@
module.exports = {
env: {
browser: true,
es2021: true,
},
extends: [
"plugin:react/recommended",
"airbnb-typescript",
"plugin:import/typescript",
// @NOTE: Make sure this is always the last element in the array.
"plugin:prettier/recommended",
],
parser: "@typescript-eslint/parser",
parserOptions: {
ecmaVersion: 2020,
sourceType: "module",
ecmaFeatures: {
jsx: true,
},
project: ["./tsconfig.json"],
},
plugins: [
"react",
"react-hooks",
"jsx-a11y",
"import",
"prettier",
"@typescript-eslint",
"plugin:@docusaurus/recommended",
],
settings: {
react: {
pragma: "React", // Pragma to use, default to "React"
fragment: "Fragment", // Fragment to use (may be a property of <pragma>), default to "Fragment"
version: "detect", // React version. "detect" automatically picks the version you have installed.
// You can also use `16.0`, `16.3`, etc, if you want to override the detected value.
// default to latest and warns if missing
// It will default to "detect" in the future
},
"import/parsers": {
"@typescript-eslint/parser": [".ts", ".tsx"],
},
"import/resolver": {
typescript: {},
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaVersion": "latest",
"sourceType": "module",
"ecmaFeatures": {
"jsx": true
},
project: ["./tsconfig.json"]
},
rules: {
"import/prefer-default-export": 0,
"react/prop-types": 0,
"import/no-unresolved": [
"error",
{ ignore: ["^@theme", "^@docusaurus", "^@site"] },
],
"no-nested-ternary": 0,
"no-console": 0,
"no-unused-vars": 0,
"no-use-before-define": 0,
"arrow-body-style": 0,
"jsx-a11y/anchor-is-valid": 0,
"jsx-a11y/no-static-element-interactions": 0,
"jsx-a11y/click-events-have-key-events": 0,
"@typescript-eslint/no-unused-expressions": 0,
"@typescript-eslint/no-unused-vars": ["warn", { args: "none" }],
"@typescript-eslint/no-use-before-define": "warn",
"react/require-default-props": 0,
"react/jsx-props-no-spreading": 0,
"react/button-has-type": 0,
"jsx-a11y/label-has-associated-control": [
"error",
{
labelComponents: [],
labelAttributes: [],
controlComponents: [],
assert: "either",
depth: 2,
},
],
"@typescript-eslint/naming-convention": [
"error",
{
selector: "variableLike",
leadingUnderscore: "forbid",
trailingUnderscore: "forbid",
format: ["camelCase", "PascalCase", "UPPER_CASE"],
},
],
"import/extensions": 0,
'@docusaurus/no-untranslated-text': 0
},
};
};
22 changes: 22 additions & 0 deletions .github/workflows/links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Check for broken links

on:
pull_request:
branches:
- main

jobs:

linkCheck:
name: Link Checking
runs-on: ubuntu-latest
strategy:
matrix:
file-extensions: [".md", ".mdx"]
steps:
- uses: actions/checkout@v3
- name: LinkCheck
uses: ConsenSys/docs-gha/linkcheck@main
with:
FILE_EXTENSION: ${{ matrix.file-extensions }}
13 changes: 0 additions & 13 deletions .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,3 @@ jobs:
uses: ConsenSys/docs-gha/lint@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

linkCheck:
name: Link Checking
runs-on: ubuntu-latest
strategy:
matrix:
file-extensions: [".md", ".mdx"]
steps:
- uses: actions/checkout@v3
- name: LinkCheck
uses: ConsenSys/docs-gha/linkcheck@main
with:
FILE_EXTENSION: ${{ matrix.file-extensions }}
11 changes: 0 additions & 11 deletions .prettierrc

This file was deleted.

24 changes: 8 additions & 16 deletions .stylelintrc.js
Original file line number Diff line number Diff line change
@@ -1,18 +1,10 @@
module.exports = {
extends: ["stylelint-config-standard", "stylelint-config-prettier"],
rules: {
"selector-pseudo-class-no-unknown": [
true,
{
// :global is a CSS modules feature to escape from class name hashing
ignorePseudoClasses: ["global"],
},
],
"extends": "stylelint-config-standard",
"rules": {
"selector-class-pattern": null,
"custom-property-empty-line-before": null,
"selector-id-pattern": null,
"declaration-empty-line-before": null,
"comment-empty-line-before": null,
"value-keyword-case": ["lower", { camelCaseSvgKeywords: true }],
},
};
"comment-empty-line-before" : null,
"media-feature-range-notation": null,
"selector-anb-no-unmatchable": null,
"declaration-block-no-duplicate-properties": null
}
}
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

23 changes: 15 additions & 8 deletions docs/configure-and-manage/configure/consensus-protocols/ibft.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Configuring IBFT consensus
sidebar_position: 2
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Configure IBFT consensus

GoQuorum implements the [IBFT](https://medium.com/getamis/istanbul-bft-ibft-c2758b7fe6ff) proof of authority [consensus protocol](../../../concepts/consensus-index.md). IBFT is supported for existing private networks, but [QBFT](qbft.md) is the recommended enterprise-grade consensus protocol for private networks. You can [migrate an IBFT network to QBFT](qbft.md#migrate-from-ibft-to-qbft).
Expand Down Expand Up @@ -139,9 +142,9 @@ To update an existing network with a new `blockperiodseconds`:

<br />

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```json title="Transitions configuration"
{
Expand All @@ -161,7 +164,8 @@ To update an existing network with a new `blockperiodseconds`:
}
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```json title="Transitions configuration"
{
Expand All @@ -181,7 +185,8 @@ To update an existing network with a new `blockperiodseconds`:
}
```

<!--/tabs-->
</TabItem>
</Tabs>

3. Restart all nodes in the network using the updated genesis file.
4. To verify the changes after the transition block, call [`istanbul_getValidators`](../../../reference/api-methods.md#istanbul_getvalidators), specifying `latest`.
Expand All @@ -199,9 +204,9 @@ To swap between block header validator selection and contract validator selectio

<br />

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```json title="Transitions configuration"
{
Expand All @@ -222,7 +227,8 @@ To swap between block header validator selection and contract validator selectio
}
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```json title="Transitions configuration"
{
Expand All @@ -243,6 +249,7 @@ To swap between block header validator selection and contract validator selectio
}
```

<!--/tabs-->
</TabItem>
</Tabs>

3. [Restart all nodes](../../../tutorials/private-network/create-ibft-network.md#5-initialize-nodes) in the network using the updated genesis file.
48 changes: 29 additions & 19 deletions docs/configure-and-manage/configure/consensus-protocols/qbft.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ description: Configuring QBFT consensus
sidebar_position: 1
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Configure QBFT consensus

GoQuorum implements the QBFT proof of authority [consensus protocol](../../../concepts/consensus-index.md). QBFT is the recommended enterprise-grade consensus protocol for private networks. You can [create a private network using QBFT](../../../tutorials/private-network/create-qbft-network.md).
Expand Down Expand Up @@ -161,9 +164,8 @@ To update an existing network with a new `blockperiodseconds`:

<br />

<!--tabs-->

# Syntax
<Tabs>
<TabItem value="Syntax" label="Syntax" default>

```json
{
Expand All @@ -183,7 +185,8 @@ To update an existing network with a new `blockperiodseconds`:
}
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```json
{
Expand All @@ -202,8 +205,9 @@ To update an existing network with a new `blockperiodseconds`:
...
}
```

<!--/tabs-->

</TabItem>
</Tabs>

3. run `geth init` with the new genesis file
4. Restart all nodes in the network using the updated genesis file.
Expand Down Expand Up @@ -281,9 +285,9 @@ To configure rewards, add a `transitions` configuration item and set the followi
- `miningBeneficiary` is a single account to receive benefits when the `miningBeneficiary` is set to `"fixed"`.
- `beneficiaryMode` is `"fixed"` for a fixed single account or `"validator"` for the validator that validates that block. This applies to both transaction cost rewards and block rewards.

<!--tabs-->
<Tabs>

# Single account no block reward
<TabItem value="Single account no block reward" label="Single account no block reward" default>

```json
"transitions": [{
Expand All @@ -293,7 +297,8 @@ To configure rewards, add a `transitions` configuration item and set the followi
}]
```

# Validators no block rewards
</TabItem>
<TabItem value="Validators no block rewards" label="Validators no block rewards" >

```json
"transitions": [{
Expand All @@ -302,11 +307,12 @@ To configure rewards, add a `transitions` configuration item and set the followi
}]
```

<!--/tabs-->
</TabItem>
</Tabs>

<!--tabs-->
<Tabs>

# Single account with block reward
<TabItem value="Single account with block reward" label="Single account with block reward" default>

```json
"transitions": [{
Expand All @@ -317,7 +323,8 @@ To configure rewards, add a `transitions` configuration item and set the followi
}]
```

# Validators with block rewards
</TabItem>
<TabItem value="Validators with block rewards" label="Validators with block rewards" >

```json
"transitions": [{
Expand All @@ -327,7 +334,8 @@ To configure rewards, add a `transitions` configuration item and set the followi
}]
```

<!--/tabs-->
</TabItem>
</Tabs>

### Swap validator management methods

Expand All @@ -342,9 +350,9 @@ To swap between block header validator selection and contract validator selectio

<br />

<!--tabs-->
<Tabs>

# Syntax
<TabItem value="Syntax" label="Syntax" default>

```json
{
Expand All @@ -365,7 +373,8 @@ To swap between block header validator selection and contract validator selectio
}
```

# Example
</TabItem>
<TabItem value="Example" label="Example" >

```json
{
Expand All @@ -385,7 +394,8 @@ To swap between block header validator selection and contract validator selectio
...
}
```

<!--/tabs-->

</TabItem>
</Tabs>

3. [Restart all nodes](../../../tutorials/private-network/create-qbft-network.md#5-initialize-nodes) in the network using the updated genesis file.
Loading