Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
f-w committed Dec 10, 2024
1 parent 972b580 commit 239dfc8
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/docs/api/bounce.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
permalink: /docs/api-bounce/
next: /docs/benchmarks/
next: /docs/health-check/
---

# Bounce
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api/overview.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
permalink: /docs/api-overview/
prev: /docs/config-certificates/
prev: /docs/config-queue/
---

# API Overview
Expand Down
4 changes: 4 additions & 0 deletions docs/docs/miscellaneous/benchmarks.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ prev: /docs/api-bounce/

# Benchmarks

::: warning out of date
Benchmark results no longer apply to this _NotifyBC_ version. Only the _Advices_ section is applicable.
:::

::: tip tl;dr
A <i>NotifyBC</i> server node can deliver 1 million emails in as little as 1 hour to a SMTP server node. SMTP server node's disk I/O is the bottleneck in such case. Throughput can be improved through horizontal scaling.
:::
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/miscellaneous/disaster-recovery.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ permalink: /docs/disaster-recovery/

# Disaster Recovery

_NotifyBC_ consists of three runtime components
_NotifyBC_ consists of three runtime components with dependencies

```mermaid
flowchart TD
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/miscellaneous/health-check.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
permalink: /docs/health-check/
prev: /docs/api-bounce/
---

# Health Check
Expand Down Expand Up @@ -43,6 +44,6 @@ The response payload shows status of following indicators and health criteria

1. MongoDB - MongoDB must be reachable
2. config - There must be at least 2 items in MongoDB configuration collection
3. Redis - Redis must be reachable if configured
3. Redis - Redis must be reachable

`/health` API end point is also reachable in _API Explorer_ of _NotifyBC_ web console.

0 comments on commit 239dfc8

Please sign in to comment.