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

Migrate to Docusaurus 3.1.0 #696

Merged
merged 3 commits into from
Jan 11, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/ci-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ jobs:
- name: Set up Node.js
uses: actions/setup-node@v2
with:
node-version: '16.x'
node-version: '18.x'
cache: yarn
- name: Build
env:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

- uses: actions/setup-node@v2
with:
node-version: 16.x
node-version: 18.x
cache: yarn

- name: Install fonts
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:

- uses: actions/setup-node@v2
with:
node-version: 16.x
node-version: 18.x
cache: yarn

- name: Build
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/deploy-main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
submodules: true
- uses: actions/setup-node@v2
with:
node-version: 16.x
node-version: 18.x
cache: yarn
- name: Build website
run: |
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ accordingly.

While all markdown files inside `docs` are compiled, not all files may be
reachable via sidebars directly. Each top-level chapter defines own
sidebar structure inside their `sidebarChapterName.js` file.
sidebar structure inside their `sidebarChapterName.ts` file.

Nouns, adjectives and verbs in the titles should be capitalized.

Expand Down Expand Up @@ -174,7 +174,7 @@ To define the region in the referenced file put `#region some-region-name` and

When you move, rename or delete previously published content, make sure that
**any previously valid URL will always point to the new valid location**. Set
up redirects in `redirects.js` accordingly and leave the pull request
up redirects in `redirects.ts` accordingly and leave the pull request
number in the comment which added this redirection for future reference, if
major rewrite is to happen and the developers would need more context around
the redirection.
Expand Down
3 changes: 0 additions & 3 deletions babel.config.js

This file was deleted.

2 changes: 1 addition & 1 deletion docs/dapp/diagrams/opl-contract-flow.mmd.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 7 additions & 7 deletions docs/dapp/emerald/writing-dapps-on-emerald.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ different compared to the original Ethereum Network!
## Oasis Consensus Layer and Emerald ParaTime

Oasis Network consists of the consensus layer and a number of Layer 2 chains
called the ParaTimes (to learn more, check the [Oasis Network Overview]
[overview] chapter). Emerald is a ParaTime which implements the Ethereum
called the ParaTimes (to learn more, check the [Oasis Network
Overview][overview] chapter). Emerald is a ParaTime which implements the Ethereum
Virtual Machine (EVM).

The minimum and also expected block time in Emerald is **6 seconds**. Any
Expand All @@ -33,8 +33,8 @@ libraries.

Finally, the ParaTimes are not allowed to directly access your tokens stored in
Consensus layer addresses. You will need to **deposit** tokens from your consensus
account to Emerald. Consult the [How to transfer ROSE into Emerald ParaTime]
[how-to-deposit-rose] chapter to learn more.
account to Emerald. Consult the [How to transfer ROSE into Emerald
ParaTime][how-to-deposit-rose] chapter to learn more.


[overview]: ../../general/oasis-network/README.mdx
Expand Down Expand Up @@ -419,9 +419,9 @@ it on the Emerald block explorer ([Mainnet][mainnet-explorer], [Testnet][testnet
In some cases, the transaction result on Emerald block explorer might be stuck
at `Error: (Awaiting internal transactions for reason)`. In this case or in
case of other Consensus layer ↔ ParaTime issues, try to find your Emerald
transaction on the Oasis Scan ([Mainnet][mainnet-oasisscan], [Testnet]
[testnet-oasisscan]) which is primarily a Consensus layer explorer, but offers
some introspection into ParaTime transactions as well. Once you find your
transaction on the Oasis Scan ([Mainnet][mainnet-oasisscan],
[Testnet][testnet-oasisscan]) which is primarily a Consensus layer explorer, but
offers some introspection into ParaTime transactions as well. Once you find your
failed Emerald transaction, the `Status` field should contain a more verbose
error description, for example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ Now you can start using that wrapped assets across new Oasis dApps like the firs

:::info

Make sure that your MetaMask is connected to the Emerald Mainnet network. You can find network parameters [here](/dapp/emerald#web3-gateway).
Make sure that your MetaMask is connected to the Emerald Mainnet chain. You
can find the network parameters [here](../../dapp/emerald/README.mdx#web3-gateway).

:::
2 changes: 1 addition & 1 deletion docs/general/manage-tokens/oasis-wallets/web.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Oasis Wallet - Web uses English mnemonic phrase words as defined in [BIP39](http

:::caution

Oasis Wallet mnemonics are incompatible with BitPie mnemonics. Check our [FAQ](./README.mdx#frequently-asked-questions) for more information.
Oasis Wallet mnemonics are incompatible with BitPie mnemonics. Check our [FAQ](../faq.mdx#how-can-i-transfer-rose-tokens-from-my-bitpie-wallet-to-my-oasis-wallet) for more information.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/general/manage-tokens/staking-and-delegating.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ In addition to using the [Oasis CLI](cli/README.md) for generating the `staking.

* [Oasis Wallet - Web](oasis-wallets/web.md)
* [Oasis Wallet - Browser Extension](oasis-wallets/browser-extension.md)
* [Copper.co](staking-and-delegating.md#rewards-and-tokenonomics) (custodian)
* [Copper.co](#rewards-and-tokenomics) (custodian)
* [Anchorage](https://anchorage.com) (custodian)
* [Finoa](https://finoa.io) (custodian)

Expand Down
12 changes: 6 additions & 6 deletions docs/get-involved/run-node/paratime-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ the use of EVM smart contracts on the Oasis network.
* **Discord Channel:** [#node-operators][connect-with-us]
* **Requires SGX:** yes
* **Parameters:**
* [Mainnet](../../node/mainnet/README.md#sapphire-paratime)
* [Testnet](../../node/testnet/README.md#sapphire-paratime)
* [Mainnet](../../node/mainnet/README.md#sapphire)
* [Testnet](../../node/testnet/README.md#sapphire)

### Features

Expand Down Expand Up @@ -86,8 +86,8 @@ EVM smart contracts on the Oasis network.
* **Discord Channel:** [#node-operators][connect-with-us]
* **Requires SGX:** No
* **Parameters:**
* [Mainnet](../../node/mainnet/README.md#emerald-paratime)
* [Testnet](../../node/testnet/README.md#emerald-paratime)
* [Mainnet](../../node/mainnet/README.md#emerald)
* [Testnet](../../node/testnet/README.md#emerald)

### Features

Expand Down Expand Up @@ -119,8 +119,8 @@ confidential smart contracts.
* **Discord Channel:** [#node-operators][connect-with-us]
* **Requires SGX:** Yes
* **Parameters:**
* [Mainnet](../../node/mainnet/README.md#cipher-paratime)
* [Testnet](../../node/testnet/README.md#cipher-paratime)
* [Mainnet](../../node/mainnet/README.md#cipher)
* [Testnet](../../node/testnet/README.md#cipher)

### Features

Expand Down
4 changes: 2 additions & 2 deletions docs/get-involved/run-node/validator-node.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ For more information about obtaining information on your entity's account, see t

Currently, you should have:

* 100 ROSE staked for your entity's registration since that is the [current entity's staking threshold](../../node/genesis-doc.md#node-and-paratime-token-thresholds).
* 100 ROSE staked for your validator node's registration since that is the [current validator node's staking threshold](../../node/genesis-doc.md#node-and-paratime-token-thresholds).
* 100 ROSE staked for your entity's registration since that is the [current entity's staking threshold](../../node/genesis-doc.md#staking-thresholds).
* 100 ROSE staked for your validator node's registration since that is the [current validator node's staking threshold](../../node/genesis-doc.md#staking-thresholds).
* Enough ROSE staked to be in the top 120 entities (by stake) so your validator will be elected into the consensus committee.

:::info
Expand Down
8 changes: 4 additions & 4 deletions docs/node/genesis-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,10 +256,10 @@ There are several **`staking.params.thresholds`** parameters that specify the
minimum number of tokens that need to be staked in order for a particular entity
or a particular type of node to participate in the network.

The **`entity`,** **`node-compute`, `node-keymanager`, and **`node-validator`**
parameters are set to 100,000,000,000 base units for each, indicating that you
need to stake at least 100 ROSE tokens in order to have your entity or any of
the specified nodes go live on the network.
The **`entity`**, **`node-compute`**, **`node-keymanager`**, and
**`node-validator`** parameters are set to 100,000,000,000 base units for each,
indicating that you need to stake at least 100 ROSE tokens in order to have your
entity or any of the specified nodes go live on the network.

The **`staking.params.thresholds`** parameters also specify the minimum
thresholds for registering new ParaTimes. The **`runtime-compute`** and
Expand Down
6 changes: 3 additions & 3 deletions docs/node/mainnet/previous-upgrades/cobalt-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This section will be updated with more details as we get closer to the upgrade.

Upgrading the Mainnet will require a coordinated upgrade of the Network. All nodes will need to configure a new genesis file that they can generate or verify independently and reset/archive any state from Mainnet. Once enough (representing 2/3+ of stake) nodes have taken this step, the upgraded network will start.

For the actual steps that node operators need to make on their nodes, see the [Upgrade Log](../upgrade-log.md#2021-04-28-16-00-utc-cobalt-upgrade).
For the actual steps that node operators need to make on their nodes, see the [Upgrade Log](../upgrade-log.md#cobalt-upgrade).

## Proposed State Changes

Expand Down Expand Up @@ -66,13 +66,13 @@ The **`epochtime`**object will be removed since it became obsolete with the new
```
* **`registry.runtimes`** list contains the registered runtimes' descriptors. In the Cobalt upgrade, it will be migrated from a list of _signed_ runtime descriptors to a list of runtime descriptors. The migration will be done automatically with the `oasis-node debug fix-genesis` command.
* **`registry.suspended_runtimes`** list contains the suspended registered runtimes' descriptors. In the Cobalt upgrade, it will be migrated from a list of _signed_ suspended runtime descriptors to a list of suspended runtime descriptors. The migration will be done automatically with the `oasis-node debug fix-genesis` command.
* Inactive registered entities in **`registry.entities`** (and their corresponding nodes in **`registry.nodes`**) that don't pass the [minimum staking thresholds](../../genesis-doc.md#node-and-paratime-token-thresholds) will be removed. The removal will be done automatically with the `oasis-node debug fix-genesis` command.
* Inactive registered entities in **`registry.entities`** (and their corresponding nodes in **`registry.nodes`**) that don't pass the [minimum staking thresholds](../../genesis-doc.md#staking-thresholds) will be removed. The removal will be done automatically with the `oasis-node debug fix-genesis` command.

:::info

Removing entities from **`registry.entities`** will effectively deregister them but the entities' accounts in **`staking.ledger`** will remain intact.

Deregistered entities can always re-register by submitting the [entity registration transaction](../../run-your-node/validator-node.mdx#generating-entity-registration-transaction) after the upgrade.
Deregistered entities can always re-register by submitting the [entity registration transaction](../../run-your-node/validator-node.mdx#entity-registration) after the upgrade.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/node/mainnet/previous-upgrades/damask-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ For the actual steps that node operators need to make on their nodes, see the
https://github.com/oasisprotocol/community
[upgrade-log-damask]: ../upgrade-log.md#damask-upgrade

## Proposed State Changes {#state-changes}
## Proposed State Changes

The following parts of the genesis document will be updated:

Expand Down
16 changes: 8 additions & 8 deletions docs/node/mainnet/upgrade-log.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,7 +341,7 @@ oasis-node governance gen_cast_vote \
```

where `TX_FLAGS` refer to previously set base and signer flags as described in
the [Oasis CLI Tools Setup] doc.
the [Oasis node CLI Tools Setup] doc.

:::caution

Expand All @@ -365,7 +365,7 @@ oasis-node consensus submit_tx \

[upgrade governance proposal]: ../../core/consensus/services/governance.md#submit-proposal
[your entity's nonce]: ../../general/manage-tokens/cli/account.md#show
[Oasis CLI Tools Setup]: ../../core/oasis-node/cli.md#storing-base-and-signer-flags-in-an-environment-variable
[Oasis node CLI Tools Setup]: ../../core/oasis-node/cli.md
[Installing Oasis App on Your Ledger Wallet]: ../../general/manage-tokens/holding-rose-tokens/ledger-wallet.md

### Instructions - Before upgrade
Expand Down Expand Up @@ -467,7 +467,7 @@ spin up an Oasis Node in archive mode and query the pre-Damask state.

11. Start your node and re-enable auto-starting via your process manager.

[Damask Upgrade]: previous-upgrades/damask-upgrade.md#state-changes
[Damask Upgrade]: previous-upgrades/damask-upgrade.md#proposed-state-changes
[Damask upgrade release]:
https://github.com/oasisprotocol/mainnet-artifacts/releases/tag/2022-04-11
[Handling Network Upgrades]:
Expand Down Expand Up @@ -733,11 +733,11 @@ oasis-node governance gen_cast_vote \
--transaction.fee.amount 2000
```

where `TX_FLAGS` refer to previously set base and signer flags as described in the [Oasis CLI Tools Setup](../../core/oasis-node/cli.md#storing-base-and-signer-flags-in-an-environment-variable) doc.
where `TX_FLAGS` refer to previously set base and signer flags as described in the [Oasis node CLI Tools Setup] doc.

:::caution

If you use a Ledger-signer backed entity, you will need to install version 2.3.1 of the Oasis App as described in [Installing Oasis App 2.3.1 to Your Ledger](upgrade-log.md#installing-oasis-app-2-3-1-to-your-ledger). This is needed because the current version of the Oasis App available through Ledger Live, version 1.8.2, doesn't support signing the `governance.CastVote` transaction type.
If you use a Ledger-signer backed entity, you will need to install version 2.3.1 of the Oasis App as described in [Installing Oasis App 2.3.1 to Your Ledger](#installing-oasis-app-231-to-your-ledger). This is needed because the current version of the Oasis App available through Ledger Live, version 1.8.2, doesn't support signing the `governance.CastVote` transaction type.

:::

Expand Down Expand Up @@ -1018,7 +1018,7 @@ Version **20.12.7** is backwards compatible with other **20.12.x** releases, so

:::

* To ensure your node will stop at epoch **5046** [submit the following upgrade descriptor](../run-your-node/maintenance/handling-network-upgrades.md#stop-the-node-at-specific-epoch) at any time before the upgrade:
* To ensure your node will stop at epoch **5046** [submit the following upgrade descriptor](https://github.com/oasisprotocol/cli/blob/master/docs/network.md#governance-create-proposal) at any time before the upgrade:

```
{
Expand Down Expand Up @@ -1084,7 +1084,7 @@ Mainnet state at epoch **5046** will be exported and migrated to a 21.1.x compat

:::

* Verify the provided Cobalt upgrade genesis file by comparing it to network state dump. See instructions in the [Handling Network Upgrades](../run-your-node/maintenance/handling-network-upgrades.md#download-and-verify-the-provided-genesis-file) guide.
* Verify the provided Cobalt upgrade genesis file by comparing it to network state dump. See instructions in the [Handling Network Upgrades](../run-your-node/maintenance/handling-network-upgrades.md#verify-genesis) guide.
* Replace the old genesis file with the new Cobalt upgrade genesis file.
* Stop your node (if you haven't stopped it already by submitting the upgrade descriptor).
* Replace the old version of Oasis Node with version [21.1.1](https://github.com/oasisprotocol/oasis-core/releases/tag/v21.1.1).
Expand Down Expand Up @@ -1134,7 +1134,7 @@ We expect the Mainnet Beta network to reach this block height at around 2020-11-
* Download [Oasis Node](../run-your-node/prerequisites/oasis-node.md) version [20.12.2](https://github.com/oasisprotocol/oasis-core/releases/tag/v20.12.2), while continuing to run version 20.10.x.
* (optional) Use Oasis Node version 20.12.2 to dump network state at the specified block height. It will connect to the running version 20.10.x node.
* Download the Mainnet genesis file published in the [2020-11-18 release](https://github.com/oasisprotocol/mainnet-artifacts/releases/tag/2020-11-18).
* (optional) Verify the provided Mainnet genesis file by comparing it to network state dump. See instructions in the [Handling Network Upgrades](../run-your-node/maintenance/handling-network-upgrades.md#download-and-verify-the-provided-genesis-file) guide.
* (optional) Verify the provided Mainnet genesis file by comparing it to network state dump. See instructions in the [Handling Network Upgrades](../run-your-node/maintenance/handling-network-upgrades.md#verify-genesis) guide.
* Replace the old Mainnet Beta genesis file with the Mainnet genesis file.
* Stop your node.
* Remove the old 20.10.x version of Oasis Node.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ policy.
The trusted key manager policy signer set (i.e. the authorized public keys) and
the threshold of keys that need to sign the policy are hard-coded in the key
manager's source code.
The trusted signer set for the Oasis Key Manager is defined in [its source code
][oasis-km-signer-set].
The trusted signer set for the Oasis Key Manager is defined in [its source
code][oasis-km-signer-set].

:::danger

Expand Down Expand Up @@ -68,23 +68,20 @@ manager policy signer set and hence the key manager itself.

:::



[key manager policy]:
https://github.com/oasisprotocol/oasis-core/blob/master/docs/consensus/services/keymanager.md#policies
[Oasis Node binary installation guide]: ../prerequisites/oasis-node.md
[oasis-km-signer-set]:
https://github.com/oasisprotocol/keymanager-paratime/blob/main/src/lib.rs
[instructions in our Validator Node guide]:
../validator-node/#initializing-an-entity
[instructions in our Validator Node guide]: ../validator-node.mdx#initialize-entity
[offline/air-gapped machine]:
https://en.wikipedia.org/wiki/Air_gap_\(networking\)

## Define Variables

For easier handling of key manager policy files, define the following variables:

```
```shell
POLICY=path/to/policy.cbor
KEY=path/to/entity/key.pem
NAME=your_name
Expand All @@ -94,7 +91,7 @@ NAME=your_name

To print and inspect a key manager policy, use the following command:

```bash
```shell
oasis-node keymanager verify_policy \
--keymanager.policy.file $POLICY \
--keymanager.policy.ignore.signature \
Expand Down
2 changes: 1 addition & 1 deletion docs/node/run-your-node/paratime-client-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ For each ParaTime, you need to obtain its bundle and install it to the

:::info

For example, for the [Cipher ParaTime](../mainnet/README.md#cipher-paratime),
For example, for the [Cipher ParaTime](../mainnet/README.md#cipher),
you would have to obtain the `cipher-paratime.orc` bundle and install it to
`/node/runtimes/cipher-paratime.orc`.

Expand Down
8 changes: 4 additions & 4 deletions docs/node/run-your-node/paratime-node.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ command, for example:

[Initialize Entity]: validator-node.mdx#initialize-entity
[Starting the Oasis Node]: validator-node.mdx#starting-the-oasis-node
[list your node ID]: validator-node.mdx#adding-your-node-id-to-the-entity-descriptor
[list your node ID]: validator-node.mdx#add-your-node-id-to-the-entity-descriptor
[Register]: validator-node.mdx#entity-registration
[`oasis account withdraw`]: ../../general/manage-tokens/cli/account.md#withdraw

Expand Down Expand Up @@ -191,7 +191,7 @@ For each ParaTime, you need to obtain its bundle and install it to the

:::info

For example, for the [Cipher ParaTime](../mainnet/README.md#cipher-paratime),
For example, for the [Cipher ParaTime](../mainnet/README.md#cipher),
you would have to obtain the `cipher-paratime.orc` bundle and install it to
`/node/runtimes/cipher-paratime.orc`.

Expand Down Expand Up @@ -314,7 +314,7 @@ runtime:
paths:
# Paths to ParaTime bundles for all of the supported ParaTimes.
- {{ runtime_orc_path }}
# The following section is required for ParaTimes which are running inside
# The following section is required for ParaTimes which are running inside
# the Intel SGX Trusted Execution Environment.
sgx_loader: /node/bin/oasis-core-runtime-loader
```
Expand Down Expand Up @@ -359,7 +359,7 @@ See the general [Node troubleshooting](troubleshooting.md) and [Set up TEE troub

### Too Old Bubblewrap Version

Double check your installed `bubblewrap` version, and ensure is at least of version **0.3.3**. For details see the [Install Bubblewrap Sandbox](paratime-node.mdx#install-bubblewrap-sandbox-at-least-version-0-3-3) section.
Double check your installed `bubblewrap` version, and ensure is at least of version **0.3.3**. For details see the [Install Bubblewrap Sandbox](#install-bubblewrap-sandbox-at-least-version-033) section.

### Bubblewrap Sandbox Fails to Start

Expand Down
Loading
Loading