diff --git a/docs/Development/Contributing/Documentation/Public-Docs.md b/docs/Development/Contributing/Documentation/Public-Docs.md index f14a56b13..1393c2a09 100644 --- a/docs/Development/Contributing/Documentation/Public-Docs.md +++ b/docs/Development/Contributing/Documentation/Public-Docs.md @@ -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 diff --git a/docs/Development/Testing/Rollback-Tests.md b/docs/Development/Testing/Rollback-Tests.md index 4ca55f479..385fd77ee 100644 --- a/docs/Development/Testing/Rollback-Tests.md +++ b/docs/Development/Testing/Rollback-Tests.md @@ -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 @@ -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 diff --git a/docs/Explanation/Image-Streaming-Pipeline.md b/docs/Explanation/Image-Streaming-Pipeline.md index 1e3baf778..b39441a64 100644 --- a/docs/Explanation/Image-Streaming-Pipeline.md +++ b/docs/Explanation/Image-Streaming-Pipeline.md @@ -25,13 +25,13 @@ increase provisioning time. Streaming solves both problems: ## Pipeline Stages -:::mermaid +```mermaid flowchart LR Remote["Remote Source
(HTTP / OCI)"] --> HttpSubFile["HTTP Range
Reader"] HttpSubFile --> Hash["SHA-384
Hasher"] Hash --> Decompress["ZSTD
Decompressor"] Decompress --> Disk["Target
Partition"] -::: +``` ### Remote Source diff --git a/docs/Explanation/gRPC-Server.md b/docs/Explanation/gRPC-Server.md index 78a3111bb..02949fdeb 100644 --- a/docs/Explanation/gRPC-Server.md +++ b/docs/Explanation/gRPC-Server.md @@ -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