Skip to content

Commit

Permalink
updates to index pages in node operators section
Browse files Browse the repository at this point in the history
  • Loading branch information
dawnkelly09 committed Jan 3, 2025
1 parent b5316c7 commit 38286f9
Show file tree
Hide file tree
Showing 10 changed files with 24 additions and 26 deletions.
4 changes: 2 additions & 2 deletions builders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Explore everything you need to build, deploy, and manage networks within the Tan

<div class="grid cards" markdown>

- <h2 class="title">Tanssi Network Information</h2>
[:octicons-arrow-right-24: Access network endpoints for integration](/builders/tanssi-network/endpoints/)
- <h2 class="title">Tanssi Network References</h2>
[:octicons-arrow-right-24: Network Endpoints](/builders/tanssi-network/endpoints/)

- <h2 class="title">Tools for Tanssi Network Development</h2>
[:octicons-arrow-right-24: Explore tools for Ethereum API integration](/builders/toolkit/ethereum-api/)
Expand Down
9 changes: 3 additions & 6 deletions node-operators/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,10 @@ Whether you're setting up for the first time, handling operational tasks, or ret

### Node Types in the Tanssi Ecosystem

Understanding the roles of different nodes in the Tanssi-powered network helps you choose the right one based on your goals:
Understanding the roles of different nodes in the Tanssi-powered network helps you choose the right one based on your desired level of participation in the Tanssi ecosystem:

- **Network nodes** - these nodes provide RPC endpoints and data availability services, ensuring smooth data flow and interaction between chains and users
- **Sequencers** - Sequencers are responsible for producing blocks, executing transactions, and maintaining the network's liveness by ensuring its operational continuity

!!!tip
With this in mind, you can decide whether to set up a network node or become a sequencer depending on your desired level of participation in the Tanssi ecosystem.
- [**Network nodes**](/node-operators/network-node/) - provide RPC endpoints and data availability services for smooth data flow and interaction between chains and users
- [**Sequencers**](/node-operators/sequencers/) - responsible for block production, transaction execution, and network maintenance to ensure liveness and operational continuity

## Explore What This Section Covers

Expand Down
6 changes: 3 additions & 3 deletions node-operators/network-node/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ template: index-page.html

# Run a Network Node

Setting up a network node is essential for interacting with your Tanssi-powered network, providing a secure and dedicated RPC endpoint. This section offers step-by-step guides to help you deploy and manage your node effectively.
Setting up a network node is essential for interacting with your Tanssi-powered network, providing a secure and dedicated RPC endpoint. This section offers step-by-step guides to help you deploy and manage your node effectively. Options using a containerized environment and node as a service automation are included:

- **Using Docker** - instructions to set up your node in a containerized environment for easy deployment and isolation
- **Using Systemd** - guidance for configuring your node as a service, enabling automated management and system integration
- [**Using Docker**](/node-operators/network-node/rpc-docker/) - instructions to set up your node in a containerized environment for easy deployment and isolation
- [**Using Systemd**](/node-operators/network-node/rpc-systemd/) - guidance for configuring your node as a service, enabling automated management and system integration

## Explore What This Section Covers

Expand Down
2 changes: 1 addition & 1 deletion node-operators/sequencers/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tanssi Sequencers
description: Learn how to set up, run, and manage Sequencers (block producers) to participate in the Tanssi infrastructure protocol and earn rewards.
description: Learn how to set up, run, and manage sequencers (block producers) to participate in the Tanssi infrastructure protocol and earn rewards.
icon: octicons-server-24
template: index-page.html
---
Expand Down
11 changes: 6 additions & 5 deletions node-operators/sequencers/offboarding/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Offboard Your Sequencer Node
description: Learn how to properly offboard your Sequencer node (also known as block producers) including clearing session keys and undelegating funds.
description: Learn how to properly offboard your sequencer node (also known as block producers) including clearing session keys and undelegating funds.
icon: octicons-arrow-down-right-24
template: index-page.html
---
Expand All @@ -11,12 +11,13 @@ Stepping down as a sequencer requires following the proper procedures to ensure

What you’ll learn:

- **Removing your self-delegation** - steps to remove your self-bonded stake and ensure your sequencer is no longer listed as an eligible participant
- **Unmapping session keys** - how to unmap your session keys, properly severing the connection between your node and your account
- [**Removing your self-delegation**](/node-operators/sequencers/offboarding/account/#request-undelegation) - steps to remove your self-bonded stake and ensure your sequencer is no longer listed as an eligible participant
- [**Unmapping session keys**](/node-operators/sequencers/offboarding/account/#unmap-session-keys) - how to unmap your session keys, properly severing the connection between your node and your account

!!! tip "Rejoining as a Sequencer"
If you decide to return as a Tanssi sequencer in the future, you can easily onboard again by following the steps outlined in the [Onboarding](/node-operators/sequencers/onboarding/) guide.

## Explore What This Section Covers

:::INSERT_GENERATED_CARDS:::

!!! tip "Rejoining as a Sequencer"
If you decide to return as a Tanssi sequencer in the future, you can easily onboard again by following the steps outlined in the [Onboarding](/node-operators/sequencers/onboarding/) guide.
10 changes: 5 additions & 5 deletions node-operators/sequencers/onboarding/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Onboard to Run a Sequencer Node
description: Learn how to get started to run a Sequencer (also known as producer nodes) using Docker or Systemd to participate in the protocol.
description: Learn how to get started to run a sequencer (also known as producer nodes) using Docker or Systemd to participate in the protocol.
icon: octicons-arrow-up-right-24
template: index-page.html
---
Expand All @@ -11,10 +11,10 @@ Starting your journey as a sequencer begins here. This section covers the founda

Getting Started as a Sequencer:

- **Hardware requirements** - understand the recommended hardware specifications to ensure optimal performance of your [sequencer](/node-operators/sequencers/onboarding/run-a-sequencer/) node
- **Port configuration** - learn which network ports need to be open to facilitate proper communication within the Tanssi ecosystem
- **Session keys setup** - detailed instructions on generating and managing session keys, a vital step for enabling block production capabilities
- **Docker and systemd deployment** - choose between Docker and systemd for deploying your node, with step-by-step guides tailored for each method
- [**Hardware requirements**](/node-operators/sequencers/onboarding/run-a-sequencer/#hardware-requirements) - understand the recommended hardware specifications to ensure optimal performance of your sequencer node
- [**Port configuration**](/node-operators/sequencers/onboarding/run-a-sequencer/#required-network-ports) - learn which network ports need to be open to facilitate proper communication within the Tanssi ecosystem
- **Session keys setup** - detailed instructions on [generating](/node-operators/sequencers/onboarding/account-setup/#map-account) and [managing](/node-operators/sequencers/onboarding/account-setup/#map-session-keys) session keys, a vital step for enabling block production capabilities
- **Node deployment** - choose between [Docker](/node-operators/sequencers/onboarding/run-a-sequencer/sequencers-docker/) and [systemd](/node-operators/sequencers/onboarding/run-a-sequencer/sequencers-systemd/) for deploying your node, with step-by-step guides tailored for each method

## Explore What This Section Covers

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Run a Sequencer
description: Learn how to set up and run Sequencer node (also known as block producers or collators) using Docker or Systemd to participate in the protocol.
description: Learn how to set up and run sequencer node (also known as block producers or collators) using Docker or Systemd to participate in the protocol.
icon: octicons-server-24
template: index-page.html
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Run a Sequencer Using Docker
description: Learn how to set up and run a Sequencer (aka block producer) for Tanssi-powered networks using Docker to participate in the protocol and earn rewards.
description: Learn how to set up and run a sequencer (aka block producer) for Tanssi-powered networks using Docker to participate in the protocol and earn rewards.
icon: simple-docker
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Upgrade Your Sequencer Docker Node
description: Follow these instructions to update your Tanssi Sequencer node running via Docker to the latest version of the Tanssi client software.
description: Follow these instructions to update your Tanssi sequencer node running via Docker to the latest version of the Tanssi client software.
icon: simple-docker
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Upgrade Your Sequencer Systemd Node
description: Follow these instructions to update your Tanssi Sequencer node running via Systemd to the latest version of the Tanssi client software.
description: Follow these instructions to update your Tanssi sequencer node running via Systemd to the latest version of the Tanssi client software.
icon: simple-linux
---

Expand Down

0 comments on commit 38286f9

Please sign in to comment.