Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/Development/Contributing/Documentation/Public-Docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,15 @@ When linking to resources, use relative paths to the `/docs/resources` directory
Prefer the use of mermaid diagrams embedded in markdown files. This allows for
easy editing and version control of diagrams.

```markdown
:::mermaid
````markdown
```mermaid
flowchart TD
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
:::
```
````

### Internal Links

Expand Down
9 changes: 4 additions & 5 deletions docs/Development/Testing/Rollback-Tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ extensions:

All image configs live under `tests/images/trident-vm-testimage/base/`. The
base image is `qemu_guest` (see
[Servicing Tests — Create the qemu\_guest Base Image](Servicing-Tests.md#4-create-the-qemu_guest-base-image)
for how to create it from the publicly available `baremetal` image on MCR).
[Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image)
for how to download it from the publicly available `minimal-os` image on MCR).

**`trident-vm-usr-verity-testimage`** (recommended) uses systemd-boot with a
Unified Kernel Image (UKI) and `/usr` dm-verity. This is the only image type
Expand Down Expand Up @@ -99,9 +99,8 @@ make artifacts/id_rsa
### 4. Create the qemu\_guest Base Image

Follow the instructions in
[Servicing Tests — Create the qemu\_guest Base Image](Servicing-Tests.md#4-create-the-qemu_guest-base-image)
to download the `baremetal` image from MCR and convert it to `qemu_guest.vhdx`
using Image Customizer.
[Servicing Tests — Download the qemu\_guest Base Image](Servicing-Tests.md#4-download-the-qemu_guest-base-image)
to download the `minimal-os` image from MCR and rename it to `qemu_guest.vhdx`.

### 5. Build Extension Images

Expand Down
4 changes: 2 additions & 2 deletions docs/Explanation/Image-Streaming-Pipeline.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@ increase provisioning time. Streaming solves both problems:

## Pipeline Stages

:::mermaid
```mermaid
flowchart LR
Remote["Remote Source<br/>(HTTP / OCI)"] --> HttpSubFile["HTTP Range<br/>Reader"]
HttpSubFile --> Hash["SHA-384<br/>Hasher"]
Hash --> Decompress["ZSTD<br/>Decompressor"]
Decompress --> Disk["Target<br/>Partition"]
:::
```

### Remote Source

Expand Down
4 changes: 2 additions & 2 deletions docs/Explanation/gRPC-Server.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ Rust gRPC framework built on top of the Tokio async runtime. The API is defined
in Protocol Buffer files under the `proto/` directory and compiled into Rust
types by the `trident-proto` crate.

:::mermaid
```mermaid
flowchart LR
Client["gRPC Client"] -- Unix Socket --> Server["Trident Daemon\n(tridentd)"]
Server --> Version["VersionService"]
Server --> Streaming["StreamingService"]
Server --> Update["UpdateService"]
Server --> Commit["CommitService"]
:::
```

### Unix Domain Socket

Expand Down
Loading