Skip to content

Commit

Permalink
Merge pull request #1217 from casper-network/1202_index_cleanup
Browse files Browse the repository at this point in the history
1202 index file cleanup
  • Loading branch information
ipopescu authored Jul 19, 2023
2 parents 9f8ca3b + 0a34a59 commit 3b03033
Show file tree
Hide file tree
Showing 24 changed files with 210 additions and 64 deletions.
115 changes: 84 additions & 31 deletions config/sidebar.config.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
concepts: [
"concepts/index",
"concepts/index", // TODO show concepts in breadcrumbs
"concepts/intro-to-dapps",
"concepts/accounts-and-keys",
"concepts/hash-types",
Expand All @@ -15,21 +15,22 @@ module.exports = {
label: "Design",
collapsible: true,
collapsed: true,
items: [
"concepts/design/index",
"concepts/design/casper-design",
"concepts/design/p2p",
"concepts/design/highway",
"concepts/design/reading-and-writing-to-the-blockchain",
],
link: {
type: "doc",
id: "concepts/design/index",
},
items: ["concepts/design/casper-design", "concepts/design/p2p", "concepts/design/highway", "concepts/design/reading-and-writing-to-the-blockchain"],
},
{
type: "category",
label: "Economics",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "concepts/economics/index",
},
items: [
"concepts/economics/index",
"concepts/economics/consensus",
"concepts/economics/runtime",
"concepts/economics/gas-concepts",
Expand All @@ -43,8 +44,11 @@ module.exports = {
label: "Glossary",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "concepts/glossary/index",
},
items: [
"concepts/glossary/index",
"concepts/glossary/A",
"concepts/glossary/B",
"concepts/glossary/C",
Expand Down Expand Up @@ -75,16 +79,19 @@ module.exports = {
},
],
developers: [
"developers/index",
"developers/index", // TODO show developers in breadcrumbs
"developers/table-of-contents",
"developers/prerequisites",
{
type: "category",
label: "Writing On-Chain Code",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/writing-onchain-code/index",
},
items: [
"developers/writing-onchain-code/index",
"developers/writing-onchain-code/getting-started",
"developers/writing-onchain-code/assembly-script",
"developers/writing-onchain-code/simple-contract",
Expand All @@ -102,8 +109,11 @@ module.exports = {
label: "Casper JSON-RPC API",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/json-rpc/index",
},
items: [
"developers/json-rpc/index",
"developers/json-rpc/guidance",
"developers/json-rpc/minimal-compliance",
"developers/json-rpc/json-rpc-transactional",
Expand All @@ -118,17 +128,23 @@ module.exports = {
label: "Building dApps",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/dapps/index",
},
items: [
"developers/dapps/index",
"developers/dapps/dapp",
"developers/dapps/prerequisites",
{
type: "category",
label: "SDK Client Libraries",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/dapps/sdk/index",
},
items: [
"developers/dapps/sdk/index",
"developers/dapps/sdk/client-library-usage",
"developers/dapps/sdk/script-sdk",
"developers/dapps/sdk/csharp-sdk",
Expand All @@ -153,15 +169,21 @@ module.exports = {
label: "Interacting with the Blockchain using CLI",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/cli/index",
},
items: [
"developers/cli/index",
{
type: "category",
label: "Transferring Tokens",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "developers/cli/transfers/index",
},
items: [
"developers/cli/transfers/index",
"developers/cli/transfers/direct-token-transfer",
"developers/cli/transfers/multisig-deploy-transfer",
"developers/cli/transfers/verify-transfer",
Expand All @@ -176,12 +198,16 @@ module.exports = {
},
],
operators: [
"operators/index",
"operators/index", // TODO show operators in breadcrumbs
{
type: "category",
label: "Setting up a Node",
label: "Node Setup",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "operators/setup/index",
},
items: [
"operators/setup/hardware",
"operators/setup/basic-node-configuration",
Expand All @@ -195,33 +221,45 @@ module.exports = {
},
{
type: "category",
label: "Becoming a Validator",
label: "Validators",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "operators/becoming-a-validator/index",
},
items: [
"operators/becoming-a-validator/bonding",
"operators/becoming-a-validator/unbonding",
"operators/becoming-a-validator/recovering",
"operators/becoming-a-validator/inactive-vs-faulty",
"operators/becoming-a-validator/unbonding",
],
},
{
type: "category",
label: "Setting up a Network",
label: "Private Networks",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "operators/setup-network/index",
},
items: ["operators/setup-network/chain-spec", "operators/setup-network/create-private", "operators/setup-network/staging-files-for-new-network"],
},
{
type: "category",
label: "Advanced Topics",
label: "Maintenance",
collapsible: true,
collapsed: true,
items: ["operators/advanced-topics/archiving-and-restoring", "operators/advanced-topics/moving-node"],
link: {
type: "doc",
id: "operators/maintenance/index",
},
items: ["operators/maintenance/archiving-and-restoring", "operators/maintenance/moving-node"],
},
],
resources: [
"resources/index",
"resources/index", // TODO show resources in breadcrumbs
{
type: "category",
label: "Why Build on Casper",
Expand All @@ -236,15 +274,21 @@ module.exports = {
label: "Tutorials",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "resources/tutorials/index",
},
items: [
"resources/tutorials/index",
{
type: "category",
label: "Beginner Tutorials",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "resources/tutorials/beginner/index",
},
items: [
"resources/tutorials/beginner/index",
"resources/tutorials/beginner/getting-started-tutorial",
"resources/tutorials/beginner/querying-network",
"resources/tutorials/beginner/upgrade-contract",
Expand All @@ -255,8 +299,11 @@ module.exports = {
label: "A Counter on the Testnet",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "resources/tutorials/beginner/counter-testnet/index",
},
items: [
"resources/tutorials/beginner/counter-testnet/index",
"resources/tutorials/beginner/counter-testnet/overview",
"resources/tutorials/beginner/counter-testnet/commands",
"resources/tutorials/beginner/counter-testnet/walkthrough",
Expand All @@ -268,8 +315,11 @@ module.exports = {
collapsible: true,
collapsed: true,
className: "text_transform_reset",
link: {
type: "doc",
id: "resources/tutorials/beginner/counter/index",
},
items: [
"resources/tutorials/beginner/counter/index",
"resources/tutorials/beginner/counter/overview",
"resources/tutorials/beginner/counter/commands",
"resources/tutorials/beginner/counter/walkthrough",
Expand All @@ -282,8 +332,11 @@ module.exports = {
label: "Advanced Tutorials",
collapsible: true,
collapsed: true,
link: {
type: "doc",
id: "resources/tutorials/advanced/index",
},
items: [
"resources/tutorials/advanced/index",
"resources/tutorials/advanced/cross-contract",
"resources/tutorials/advanced/transfer-token-to-contract",
"resources/tutorials/advanced/two-party-multi-sig",
Expand All @@ -299,7 +352,7 @@ module.exports = {
//"resources/support", // NEW CONTENT WILL BE HERE
],
users: [
"users/index",
"users/index", // TODO show users in breadcrumbs
"users/block-explorer",
"users/delegate-ui",
"users/undelegate-ui",
Expand Down
4 changes: 4 additions & 0 deletions source/docs/casper/operators/becoming-a-validator/bonding.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Bonding
---

# Bonding as a Validator

It is recommended that a bonding request be sent once the node has completed the synchronization process. In a Casper network, bonding takes place through the auction contract via the `add_bid.wasm` contract. The auction runs for a future era, every era. The `chainspec.toml` specifies the number of slots available, and the auction will take the top N slots and create the validator set for the future era.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# Introducing Fast-sync
---
title: Fast-Sync
---

# Introducing Fast-Sync

import useBaseUrl from '@docusaurus/useBaseUrl';

Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Inactive and Faulty Nodes
---

import useBaseUrl from '@docusaurus/useBaseUrl';

# Inactive vs. Faulty Validator Nodes
Expand Down
10 changes: 10 additions & 0 deletions source/docs/casper/operators/becoming-a-validator/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Becoming a Validator

After [setting up a node](../setup/index.md), the operator can submit a bid to win a validating slot and bond to the network. This section also covers unbonding from the network, recovering from eviction, and the differences between inactive and faulty nodes.

| Title | Description |
| ----------------------------------------------------------- | ----------------------------------------------- |
|[Bonding as a Validator](./bonding.md) | A guide about the bonding process and submitting a bid |
|[Unbonding as a Validator](./unbonding.md) | The process to withdraw a bid and unbonding |
|[Recovering from Validator Eviction](./recovering.md) | Steps a validator needs to take if it is evicted from the validator set |
|[Inactive vs. Faulty Nodes](./inactive-vs-faulty.md) | The differences between inactive and faulty nodes |
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Recovery
---

import useBaseUrl from '@docusaurus/useBaseUrl';

# Recovering from Validator Eviction
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Unbonding
---

# Unbonding as a Validator

Once a bid is placed, it will remain in the state of the auction contract, even if the bid fails to win a slot immediately. New slots may become available if bonded validators leave the network or reduce their bond amounts. Therefore, a bid must be explicitly withdrawn to remove it from the auction.
Expand Down
43 changes: 12 additions & 31 deletions source/docs/casper/operators/index.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,23 @@
---
title: Introduction
title: Overview
slug: /operators
---

# Operators
# Operators Overview

Operators who wish to run node infrastructure on a Casper network, either as a standalone private network, or as part of the public network should explore this section.

Prior knowledge of Unix-based operating systems and proficiency with systemd and bash scripting are recommended. If you are unfamiliar with systemd, the [Arch Linux page on systemd](https://wiki.archlinux.org/title/systemd) is a good introduction.
Prior knowledge of Unix-based operating systems and proficiency with `systemd` and `bash` scripting are recommended. If you are unfamiliar with `systemd`, the [Arch Linux page on systemd](https://wiki.archlinux.org/title/systemd) is a good introduction.

## Requirements
Operators should know the [hardware requirements](./setup/hardware.md) before running a node.

1. Operators should know the [Hardware requirements](./setup/hardware.md) before running a node.
Also, the [network requirements](./setup/install-node.md/#network-requirements) specify how to open ports and modify the network firewall to which the node is connected. This step is necessary to allow incoming connections, enabling communication among nodes.

2. Also, the [Network requirements](./setup/install-node.md/#network-requirements) specify how to open ports and modify the network firewall to which the node is connected. This step is necessary to allow incoming connections, enabling communication among nodes.

## Table of Contents

Review the [node's configuration](./setup/basic-node-configuration.md) first.

Then, you can follow the node [installation instructions](./setup/install-node.md).

- Setting up a Node
- [Recommended Hardware Specifications](./setup/hardware.md): system requirements for the Casper Mainnet and Testnet
- [Basic Node Configuration](./setup/basic-node-configuration.md): processes and files involved in setting up a Casper node
- [Installing a Node](./setup/install-node.md): step-by-step instructions to install a Casper node
- [Setting the Open Files Limit](./setup/open-files.md): required setting for the Casper node to run correctly
- [Upgrading the Node](./setup/upgrade.md): before joining the network, the node needs to be upgraded
- [Joining a Running Network](./setup/joining.md): steps to join an existing Casper network
- [Setting up a Non-Root User](./setup/non-root-user.md): logging into the node remotely using a key
- Becoming a Validator
- [Bonding as a Validator](./becoming-a-validator/bonding.md): a guide about the bonding process and submitting a bid
- [Unbonding as a Validator](./becoming-a-validator/unbonding.md): the process to withdraw a bid and unbonding
- Setting up a Network
- [The Chain Specification](./setup-network/chain-spec.md): files needed to create a genesis block
- [Setting up a Private Casper Network](./setup-network/create-private.md): a step-by-step guide to establishing and configuring a private Casper network
- [Staging Files for a New Network](./setup-network/staging-files-for-new-network.md): a guide to hosting protocol files for a new Casper network
- Advanced Topics
- [Archiving and Restoring a Database](./advanced-topics/archiving-and-restoring.md): using `zstd` for the compression and decompression of a Casper node database and streaming from a backup location
- [Moving a Validating Node](./advanced-topics/moving-node.md): ways to move a validator node to another machine
Review the [node's configuration](./setup/basic-node-configuration.md) first. Then, you can follow the node [installation instructions](./setup/install-node.md).

| Topic | Description |
| ----------------------------------------------------------- | ----------------------------------------------- |
|[Node Setup](./setup/index.md) | How to set up a Casper node |
|[Becoming a Validator](./becoming-a-validator/index.md) | How to join a network and become a validator |
|[Private Network Setup](./setup-network/index.md) | How to set up a private Casper network |
|[Maintenance](./maintenance/index.md) | Topics related to node maintenance |
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
title: Archive and Restore a DB
---

# Archiving and Restoring a Database

This documentation describes processes for the compression and decompression of a Casper node database and streaming from a backup location.
Expand Down
Loading

0 comments on commit 3b03033

Please sign in to comment.