Skip to content

Commit 3ba39c9

Browse files
committed
docs: fix markdown table formatting and update project words
- Improve table formatting in comparison section for better readability - Remove trailing spaces from LXD configuration comment - Add technical terms to project-words.txt: debootstrap, lxdbr, noninteractive, resolv, sysfs - Ensure proper table alignment and spacing
1 parent cb57209 commit 3ba39c9

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,16 @@ This project provides two different approaches for VM provisioning and testing:
6666

6767
### 🔄 **Comparison**
6868

69-
| Feature | Local (Multipass) | CI (LXD Containers) |
70-
|---------|-------------------|-------------------|
71-
| **Nested Virtualization** | ✅ Required | ❌ Not needed |
72-
| **GitHub Actions Support** | 🔶 Discovered but undocumented | ✅ Guaranteed |
73-
| **Cloud-init Support** | ✅ Full VM boot | ✅ Container boot |
74-
| **Resource Usage** | ❌ Higher (full VMs) | ✅ Lower (containers) |
75-
| **Isolation Level** | ✅ Complete (separate kernel) | 🔶 Process-level |
76-
| **Boot Time** | ❌ Slower (full boot) | ✅ Faster (container start) |
77-
| **Systemd Services** | ✅ Full support | ✅ Full support |
78-
| **Network Isolation** | ✅ Full isolation | ✅ Container networking |
69+
| Feature | Local (Multipass) | CI (LXD Containers) |
70+
| -------------------------- | ------------------------------ | --------------------------- |
71+
| **Nested Virtualization** | ✅ Required | ❌ Not needed |
72+
| **GitHub Actions Support** | 🔶 Discovered but undocumented | ✅ Guaranteed |
73+
| **Cloud-init Support** | ✅ Full VM boot | ✅ Container boot |
74+
| **Resource Usage** | ❌ Higher (full VMs) | ✅ Lower (containers) |
75+
| **Isolation Level** | ✅ Complete (separate kernel) | 🔶 Process-level |
76+
| **Boot Time** | ❌ Slower (full boot) | ✅ Faster (container start) |
77+
| **Systemd Services** | ✅ Full support | ✅ Full support |
78+
| **Network Isolation** | ✅ Full isolation | ✅ Container networking |
7979

8080
## Configuration
8181

@@ -246,7 +246,7 @@ multipass logs torrust-vm
246246
│ │ ├── main.tf # OpenTofu configuration for Multipass VMs
247247
│ │ └── cloud-init.yml # Cloud-init configuration
248248
│ └── ci/
249-
│ ├── main.tf # OpenTofu configuration for LXD containers
249+
│ ├── main.tf # OpenTofu configuration for LXD containers
250250
│ └── cloud-init.yml # Cloud-init configuration (same as local)
251251
├── .github/
252252
│ └── workflows/

project-words.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
cloudinit
22
cpus
3+
debootstrap
34
larstobi
5+
lxdbr
46
multipassd
7+
noninteractive
58
NOPASSWD
9+
resolv
610
runcmd
11+
sysfs
712
tfstate
813
tfvars
914
tlsv

0 commit comments

Comments
 (0)