Split box definition examples into separate boxes in documentation

mariadb-corporation · Oct 4, 2024 · 4674c01 · 4674c01
1 parent 2bd0beb
commit 4674c01
Showing 1 changed file with 55 additions and 46 deletions.
diff --git a/docs/src/general_configuration/boxes.md b/docs/src/general_configuration/boxes.md
@@ -6,52 +6,61 @@ Box description files are located in `~/.config/mdbci/boxes` folder or in `confi
 ## File format:
 
 ```json
-{
-  "debian_bullseye_gcp": {
-    "provider": "gcp",
-    "architecture": "amd64",
-    "image": "debian-cloud/debian-11",
-    "platform": "debian",
-    "platform_version": "bullseye",
-    "default_machine_type": "g1-small",
-    "default_cpu_count": "1",
-    "default_memory_size": "1024",
-    "supported_instance_types": ["a2-highgpu-1g", "a2-highgpu-2g"]
-  },
-
-  "debian_bullseye_aws" : {
-    "provider": "aws",
-    "architecture": "amd64",
-    "ami": "ami-05b99bc50bd882a41",
-    "user": "admin",
-    "default_machine_type": "t3.medium",
-    "default_cpu_count": "2",
-    "default_memory_size": "4096",
-    "platform": "debian",
-    "platform_version": "bullseye",
-    "vpc": "true",
-    "supported_instance_types": ["t2.nano","t2.micro"]
-  },
-
-  "debian_bullseye_libvirt": {
-    "provider": "libvirt",
-    "architecture": "amd64",
-    "box": "generic/debian11",
-    "platform": "debian",
-    "platform_version": "bullseye"
-  },
-
-  "rhel_9_ibm": {
-    "provider": "ibm",
-    "architecture": "ppc64le",
-    "image": "RHEL9-SP4",
-    "platform": "rhel",
-    "platform_version": "9",
-    "default_machine_type": "s1022",
-    "default_cpu_count": "1",
-    "default_memory_size": "4096",
-  },
-}
+  {
+    "debian_bullseye_gcp": {
+      "provider": "gcp",
+      "architecture": "amd64",
+      "image": "debian-cloud/debian-11",
+      "platform": "debian",
+      "platform_version": "bullseye",
+      "default_machine_type": "g1-small",
+      "default_cpu_count": "1",
+      "default_memory_size": "1024",
+      "supported_instance_types": ["a2-highgpu-1g", "a2-highgpu-2g"]
+    }
+  }
+```
+```json
+  {
+    "debian_bullseye_aws" : {
+      "provider": "aws",
+      "architecture": "amd64",
+      "ami": "ami-05b99bc50bd882a41",
+      "user": "admin",
+      "default_machine_type": "t3.medium",
+      "default_cpu_count": "2",
+      "default_memory_size": "4096",
+      "platform": "debian",
+      "platform_version": "bullseye",
+      "vpc": "true",
+      "supported_instance_types": ["t2.nano","t2.micro"]
+    }
+  }
+```
+```json
+  {
+    "debian_bullseye_libvirt": {
+      "provider": "libvirt",
+      "architecture": "amd64",
+      "box": "generic/debian11",
+      "platform": "debian",
+      "platform_version": "bullseye"
+    }
+  }
+```
+```json
+  {
+    "rhel_9_ibm": {
+      "provider": "ibm",
+      "architecture": "ppc64le",
+      "image": "RHEL9-SP4",
+      "platform": "rhel",
+      "platform_version": "9",
+      "default_machine_type": "s1022",
+      "default_cpu_count": "1",
+      "default_memory_size": "4096",
+    }
+  }
 ```
 Each box name usually consists of distribution name, version and box provider