Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit d13a24d

Browse files
HomelessDinosaurdavemooreuws
authored andcommitted
remove diagrams on resource pages add linking to architecture page
1 parent d5c1f7e commit d13a24d

File tree

8 files changed

+13
-76
lines changed

8 files changed

+13
-76
lines changed

docs/apis.mdx

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,7 @@ description: 'Building HTTP APIs with Nitric'
66

77
Nitric has built-in support for web apps and HTTP API development. The `api` resource allows you to create APIs in your applications, including routing, middleware and request handlers.
88

9-
## Architecture
10-
11-
```mermaid
12-
graph LR;
13-
classDef default line-height:1.2;
14-
15-
A(Admin Api)-->B(Service A);
16-
A-->C(Service B);
17-
D(Public Api)-->B(Service A)
18-
```
19-
20-
> An API can route to many nitric services, and services can handle many APIs.
9+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/apis).
2110

2211
## Creating APIs
2312

docs/keyvalue.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ description: 'Key value stores'
66

77
Nitric provides functionality for provisioning and interacting with persistent key/value stores.
88

9+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/keyvalue).
10+
911
## Definitions
1012

1113
### Key Value Store

docs/messaging.mdx

Lines changed: 3 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,7 @@ A topic is a named resource where events can be published. They can be thought o
1414

1515
Topics are often the first choice for communication between services, since they offer stateless, scalable and highly decoupled communication.
1616

17-
### Architecture
18-
19-
```mermaid
20-
graph LR;
21-
classDef default line-height:1.2;
22-
classDef edgeLabel line-height:1.2;
23-
24-
A(Topic)-- on message -->B(Message Service);
25-
C(Publisher Service) -- publish message --> A;
26-
D(Publisher Batch Service) -- publish message --> A;
27-
```
28-
29-
`Services` can both publish and subscribe to topics. `Batch Services` may only publish messages.
17+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/topics).
3018

3119
### Subscriptions
3220

@@ -378,6 +366,8 @@ Queues are another option for asynchronous messaging. Unlike [topics](#topics),
378366

379367
This makes queues ideal for batch workloads, often paired with [schedules](/schedules).
380368

369+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/queues).
370+
381371
<Note>
382372
Queue disambiguation: Some systems and cloud providers use the term "queue" to
383373
refer to a messaging broker with features akin to a topic (i.e. they can push

docs/schedules.mdx

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,7 @@ The `schedule` resource lets you define named schedules, including their frequen
1010

1111
If you're looking for a way to perform once-off work at some point in the future, use [delayed messaging](./messaging#delayed-messaging) instead of schedules.
1212

13-
## Architecture
14-
15-
```mermaid
16-
graph LR;
17-
classDef default line-height:1.2;
18-
19-
A(Weekly Schedule)-->B(Service A);
20-
```
21-
22-
> Schedules can be used to trigger a single service at a set cadence
13+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/schedules).
2314

2415
## Creating schedules
2516

docs/secrets.mdx

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,7 @@ Nitric Secrets simplifies the secure storage, updating, and retrieval of sensiti
88

99
Alternatively, you can choose to store these values as environment variables. Learn more about it [here](/reference/env).
1010

11-
### Architecture
12-
13-
```mermaid
14-
graph LR;
15-
classDef default line-height:1.2;
16-
classDef edgeLabel line-height:1.2;
17-
18-
B(Service)-- access/put secret -->A(Secret);
19-
C(Batch Service) -- access/put secret --> A;
20-
```
21-
22-
Both `Services` and `Batch Services` can access and put secrets values.
11+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/secrets).
2312

2413
## Definitions
2514

docs/sql.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ description: 'SQL databases'
66

77
Nitric provides functionality for provisioning and interacting with SQL databases.
88

9+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/sql).
10+
911
<Note>
1012
SQL databases are currently in preview and only support PostgreSql deployed to
1113
AWS using the <br className="hidden lg:block" />

docs/storage.mdx

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,7 @@ description: 'Working with files and storage in Nitric'
66

77
Nitric provides storage support for securely storing and retrieving large files in the cloud.
88

9-
## Architecture
10-
11-
```mermaid
12-
graph LR;
13-
classDef default line-height:1.2;
14-
classDef edgeLabel line-height:1.2;
15-
16-
A(Bucket)-- on write -->B(Bucket Handler Service);
17-
C(Bucket File Service) -- read/write/delete files --> A;
18-
D(Image Processing Batch Service) -- read/write/delete files --> A;
19-
```
20-
21-
A `Service` can both interact file files in a `Bucket` and receive notifications when files are written or deleted. A `Batch Service` can only interact with files on a bucket but cannot subscribe to file changes.
9+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/buckets).
2210

2311
## Definitions
2412

docs/websockets.mdx

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,14 @@ description: 'Connect and manage websockets with Nitric'
66

77
Nitric provides support for serverless websockets. This feature allows you to connect client applications to your Nitric services using websocket gateways such as AWS APIGateway.
88

9+
If you're interested in the architecture, provisioning, or deployment steps, they can be found [here](/architecture/websockets).
10+
911
<Note>
1012
Projects with websockets will only be deployable to AWS at the moment. If you
1113
require support for additional clouds let us know:
1214
https://github.com/nitrictech/nitric/issues
1315
</Note>
1416

15-
## Architecture
16-
17-
```mermaid
18-
graph LR;
19-
classDef default line-height:1.2;
20-
classDef edgeLabel line-height:1.2;
21-
22-
A(Websocket Gateway)-- on connect -->B(Connection Handler Service);
23-
A -- on disconnect --> B;
24-
A -- on message --> C(Message Handler Service);
25-
C -- send message --> A;
26-
D(Batch Service) -- send message --> A;
27-
```
28-
29-
A `Service` can both receive and send messages to a `Websocket`, `Batch Services` may only send message to a `Websocket`.
30-
3117
## Listening for events
3218

3319
There are three events that must be defined to deploy a valid websocket implementation. These are `connect`, `disconnect` and `message`.

0 commit comments

Comments
 (0)