This is an automated email from the ASF dual-hosted git repository.
He-Pin pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pekko.git
The following commit(s) were added to refs/heads/main by this push:
new 08c841f0f1 docs: link the fault tolerance sample from the fault
tolerance page (#3581)
08c841f0f1 is described below
commit 08c841f0f1dcd05e5d1040a811f8598ccebd73b4
Author: PJ Fanning <[email protected]>
AuthorDate: Fri Oct 9 05:28:04 2026 +0100
docs: link the fault tolerance sample from the fault tolerance page (#3581)
Motivation:
The "Fault Handling in Practice" section of fault-tolerance.md says
"Read the following source code" but nothing follows. The sample it
refers to lives in fault-tolerance-sample.md, which no page links to;
it is only built because project/Paradox.scala lists it as a paradox
root, with a TODO noting that it is not linked.
Modification:
- fault-tolerance.md: link to the Fault Tolerance Sample page from
the "Fault Handling in Practice" section
- project/Paradox.scala: replace the TODO with a comment explaining
why the page is still a paradox root (it is linked but not in the
TOC)
Result:
Readers of the fault tolerance page can reach the sample diagrams and
full source code.
Tests:
- Not run - docs only
References:
None - found during a review of the docs
---
docs/src/main/paradox/fault-tolerance.md | 7 ++++---
project/Paradox.scala | 2 +-
2 files changed, 5 insertions(+), 4 deletions(-)
diff --git a/docs/src/main/paradox/fault-tolerance.md
b/docs/src/main/paradox/fault-tolerance.md
index 9db5147c35..5ab7bc984b 100644
--- a/docs/src/main/paradox/fault-tolerance.md
+++ b/docs/src/main/paradox/fault-tolerance.md
@@ -30,9 +30,10 @@ which is a typical source of failure in real world
applications. Of course it de
on the actual application what is possible to do when the data store is
unavailable,
but in this sample we use a best effort re-connect approach.
-Read the following source code. The inlined comments explain the different
pieces of
-the fault handling and why they are added. It is also highly recommended to
run this
-sample as it is easy to follow the log output to understand what is happening
at runtime.
+Read the source code of the @ref:[Fault Tolerance
Sample](fault-tolerance-sample.md#fault-tolerance-sample).
+The inlined comments explain the different pieces of the fault handling and
why they are added.
+It is also highly recommended to run this sample as it is easy to follow the
log output to
+understand what is happening at runtime.
## Creating a Supervisor Strategy
diff --git a/project/Paradox.scala b/project/Paradox.scala
index d3df383e1b..dabca980a9 100644
--- a/project/Paradox.scala
+++ b/project/Paradox.scala
@@ -78,7 +78,7 @@ object Paradox {
lazy val rootsSettings = Seq(
paradoxRoots := List(
"index.html",
- // TODO page not linked to
+ // linked from fault-tolerance.md, not in the TOC
"fault-tolerance-sample.html"))
lazy val themeSettings = Seq(
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
