Recast this as a node/baker/DAL tutorial

trilitech · Dec 18, 2024 · e0b5ecf · e0b5ecf
1 parent 0939354
commit e0b5ecf
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 9 deletions.
diff --git a/docs/architecture/nodes.md b/docs/architecture/nodes.md
@@ -28,6 +28,8 @@ Nodes cooperate with clients and with each other through an [RPC interface](#the
 
 The Octez suite, which is an implementation of the Tezos node and other executables, instantiates these principles in the [Octez software architecture](https://tezos.gitlab.io/shell/the_big_picture.html).
 
+For instructions on running a node, see the tutorial [Run a Tezos node in 5 steps](/tutorials/join-dal-baker).
+
 ## Protocol and shell
 
 The software that runs Tezos nodes is split into two main parts:

diff --git a/docs/tutorials/join-dal-baker.md b/docs/tutorials/join-dal-baker.md
@@ -1,15 +1,28 @@
 ---
-title: Join the DAL as a baker in 5 steps
+title: Run a Tezos node in 5 steps
 authors: Tezos core developers, Tim McMackin
 last_update:
-  date: 21 October 2024
+  date: 18 December 2024
 ---
 
+As described in [Nodes](/architecutre/nodes), Tezos nodes are peer-to-peer programs that run the Tezos network.
+Anyone can run a node, and they might do so for many different reasons, including:
+
+- Running nodes makes the Tezos network resilient and secure
+- Public nodes may have rate limits, so running your own node allows you to send unlimited requests to it to get information about Tezos or to send transactions from your dApps
+- Running a node is part of being a baker and receiving the rewards for baking
+
+This tutorial covers setting up a Tezos node as a baker, which includes running these processes:
+
+- An Octez node, sometimes referred to as a Tezos node
+- A baker daemon
+- A [Data Availability Layer](/architecture/data-availability-layer) node
+
+## Why is a DAL node needed?
+
 The Tezos data availability layer (DAL) is a peer-to-peer network that Tezos Smart Rollups can use to fetch data securely.
 The DAL is a key component for the scalability and bandwidth of Tezos and it's important for bakers to run DAL nodes along with their layer 1 nodes.
 
-## Why are DAL bakers needed?
-
 When users and dApps submit data to the DAL, bakers use DAL nodes to verify that the data is available.
 Then the bakers attest that the data is available.
 Smart Rollup nodes can retrieve the data from DAL nodes only when enough bakers have attested that the data is available.

diff --git a/docs/tutorials/join-dal-baker/run-baker.md b/docs/tutorials/join-dal-baker/run-baker.md
@@ -2,10 +2,11 @@
 title: "Step 4: Run an Octez baking daemon"
 authors: Tezos core developers, Tim McMackin
 last_update:
-  date: 2 December 2024
+  date: 18 December 2024
 ---
 
-Now that you have a DAL node, you can run a baking daemon that can attest to DAL data or restart an existing baking daemon to connect it to the DAL node.
+Now that you have a layer 1 node and a DAL node, you can run a baking daemon that can create blocks and attests to DAL data.
+If you already have a baking daemon, you can restart it to connect to the DAL node.
 
 1. To run a baking daemon that connects to the DAL, start it as usual and pass the URL to your DAL node to it with the `--dal-node` argument:
 

diff --git a/docs/tutorials/join-dal-baker/run-dal-node.md b/docs/tutorials/join-dal-baker/run-dal-node.md
@@ -2,10 +2,11 @@
 title: "Step 3: Run an Octez DAL node"
 authors: Tezos core developers, Tim McMackin
 last_update:
-  date: 2 December 2024
+  date: 18 December 2024
 ---
 
 The DAL node is responsible for temporarily storing data and providing it to bakers and Smart Rollups.
+Follow these steps to run the DAL node:
 
 1. Ensure that the port that the DAL node runs on (by default, 11732) is accessible from outside its system.
 You may need to adapt your firewall rules or set up network address translation (NAT) to direct external traffic to the DAL node.

diff --git a/docs/tutorials/join-dal-baker/run-node.md b/docs/tutorials/join-dal-baker/run-node.md
@@ -5,7 +5,7 @@ last_update:
   date: 2 December 2024
 ---
 
-The first thing you need to run a baker and a DAL node is a Tezos layer 1 node, which is an instance of the `octez-node` program and part of the Octez suite of programs.
+The first thing you need is a Tezos layer 1 node, which is an instance of the `octez-node` program and part of the Octez suite of programs.
 
 ## Installing Octez
 

diff --git a/sidebars.js b/sidebars.js
@@ -333,7 +333,7 @@ const sidebars = {
     'tutorials/create-an-nft/nft-tznft',
     {
       type: 'category',
-      label: 'Join the DAL as a baker',
+      label: 'Run a Tezos node in 5 steps',
       link: {
         type: 'doc',
         id: 'tutorials/join-dal-baker',