freezing guide first draft

ethersphere · Jul 10, 2024 · 84e529d · 84e529d
2 parents 0412b97 + 9473c1a
commit 84e529d
Show file tree

Hide file tree

Showing 8 changed files with 1,122 additions and 577 deletions.
diff --git a/docs/bee/installation/install.md b/docs/bee/installation/install.md
diff --git a/docs/bee/installation/quick-start.md b/docs/bee/installation/quick-start.md
@@ -23,9 +23,13 @@ Bee is a versatile piece of software that caters to a diverse array of use cases
 
 :::info 
 The Swarm network includes two incentives protocols which each give Bee nodes incentives to participate in maintaining the network in a healthy way.
-### Storage incentives:**
+
+**Storage incentives:**
+
   By participating in the storage incentives protocol, full nodes which store and share data chunks with the network have a chance to earn xBZZ. Staked xBZZ is required to earn storage incentives. Learn more in the [staking section](/docs/bee/working-with-bee/staking).
-### SWAP incentives:**
+
+**SWAP incentives:**
+
   The SWAP incentives protocol encourages full or light (but not ultra-light) nodes to share bandwidth with other nodes in exchange for payments from other nodes either [in-kind](https://www.investopedia.com/terms/p/paymentinkind.asp) or as a cheque to be settled at a future date. SWAP requires a chequebook contract to be set up on Gnosis Chain for each participating node. 
 :::
 

diff --git a/docs/bee/working-with-bee/configuration.md b/docs/bee/working-with-bee/configuration.md
diff --git a/docs/bee/working-with-bee/troubleshooting.md b/docs/bee/working-with-bee/troubleshooting.md
diff --git a/docs/desktop/configuration.md b/docs/desktop/configuration.md
@@ -12,7 +12,7 @@ To modify the RPC endpoint, first navigate to the ***Settings*** tab:
 
 ![](/img/config1.png)
 
-From the ***Settings*** tab, expand the API Settings section and click the pen button next to Blockchain RPC URL to edit the default RPC. You can choose any valid Gnosis Chain RPC, either from your own Gnosis node or a service provider. You can find a list of paid and free RPC options from the [Gnosis Chain docs](https://docs.gnosischain.com/tools/rpc/). For this example we will use the free endpoint - *https://rpc.gnosischain.com/*.
+From the ***Settings*** tab, expand the API Settings section and click the pen button next to Blockchain RPC URL to edit the default RPC. You can choose any valid Gnosis Chain RPC, either from your own Gnosis node or a service provider. You can find a list of paid and free RPC options from the [Gnosis Chain docs](https://docs.gnosischain.com/tools/RPC%20Providers/). For this example we will use the free endpoint - *https://rpc.gnosischain.com/*.
 
 ![](/img/config2.png)
 

diff --git a/docs/develop/access-the-swarm/erasure-coding.md b/docs/develop/access-the-swarm/erasure-coding.md
@@ -15,14 +15,16 @@ To upload data to Swarm using erasure coding, the `swarm-redundancy-level: <inte
 
 ```bash
     curl \
-        -X POST http://localhost:1633/bzz?name=test.txt \
-        -H "swarm-redundancy-level: 4" \
-        -H "swarm-postage-batch-id: 27d1bbef6c01e266d3130c01c9be60fd76b4a69d6f8ea6291548e1644bcf9001" \
-        -H "Content-Type: text/plain" 
+    -X POST http://localhost:1633/bzz?name=test.txt \
+    -H "swarm-redundancy-level: 1" \
+    -H "swarm-postage-batch-id: 54ba8e39a4f74ccfc7f903121e4d5d0fc40732b19efef5c8894d1f03bdd0f4c5" \
+    -H "Content-Type: text/plain" \
+    --data-binary @test.txt
 
     {"reference":"c02e7d943fbc0e753540f377853b7181227a83e773870847765143681511c97d"}
 ```
 
+
 The accepted values for the `swarm-redundancy-level` header range from the default of 0 up to 4. Each level corresponds to a different level of data protection, with erasure coding turned off at 0, and at its maximum at 4. Each increasing level provides increasing amount of data redundancy offering greater protection against data loss. Each level has been formulated to guarantee against a certain percentage of chunk retrieval errors, shown in the table below. As long as the error rate is below the expected chunk retrieval rate for the given level, there is a less than 1 in a million chance of failure to retrieve the source data.
 
 | Redundancy Level | Pseudonym | Expected Chunk Retrieval Error Rate |

diff --git a/docs/develop/access-the-swarm/upload-and-download.md b/docs/develop/access-the-swarm/upload-and-download.md
@@ -77,7 +77,7 @@ Here, you must specify your _Batch ID_ in the `Swarm-Postage-Batch-Id` header, t
 You may also wish to employ the erasure coding feature to add greater protection for your data, see [erasure coding page](/docs/develop/access-the-swarm/erasure-coding) for more details on its usage.
 
 ```bash
- curl -XPOST -H "Swarm-Postage-Batch-Id: 54ba8e39a4f74ccfc7f903121e4d5d0fc40732b19efef5c8894d1f03bdd0f4c5" -H "Content-Type: text/plain" -H "Swarm-Encrypt: false" -v --data-binary @test.txt localhost:1633/bzz
+ curl -XPOST -H "Swarm-Postage-Batch-Id: 54ba8e39a4f74ccfc7f903121e4d5d0fc40732b19efef5c8894d1f03bdd0f4c5" -H "Content-Type: text/plain" -H "Swarm-Encrypt: false" -v --data-binary "@test.txt" localhost:1633/bzz
 ```
 
 :::danger

diff --git a/docs/develop/contribute/introduction.md b/docs/develop/contribute/introduction.md
@@ -43,18 +43,3 @@ Makefile rule `protobuf` can be used to automate `protoc-gen-gogofaster` install
 ```bash
 make protobuf
 ```
-
-## Tracing
-
-Developers can gain an additional level of insight into the node by enabling `tracing`. To make use of Tracing, we advice to make use of [jaeger](https://www.jaegertracing.io/).
-
-- Set up tracing by:
-
-  - Start jaeger:
-    `docker run -p 6831:6831/udp -p 16686:16686 jaegertracing/all-in-one:latest`
-
-  - start locally two bee nodes (different data dirs and ports) and connect them (see "Start a test network" in the [advanced section](/docs/develop/tools-and-features/starting-a-test-network)) with `--tracing` flag provided for both nodes
-
-- Make a call to the PingPong API on one of the two nodes (`curl -XPOST localhost:1735/pingpong/<overlay address other node>`).
-
-Validate tracing in the web interface (`http://localhost:16686/`).