systems: add documentation to digital-ocean image

diff --git a/infiniteadaptability/systems/digital-ocean.scm b/infiniteadaptability/systems/digital-ocean.scm
index 07e0d5bcc21ead3de5c765f208ed562ba8384ca9..28d7bf2fd545192706454265bb8e147237ed21b2 100644 (file)
--- a/infiniteadaptability/systems/digital-ocean.scm
+++ b/infiniteadaptability/systems/digital-ocean.scm
@@ -1,5 +1,20 @@
 ;; This vm image is meant to be used as an image template
 ;; to be deployed on cloud providers that use cloud-init.
+;;
+;; NOTE: This image is still a work in progress.
+;;
+;; In order to use, the network-manager-service-type
+;; and the wpa-supplicant-service-type are required. This
+;; is intended to be removed later as part of a follow-up.
+;;
+;; Additionally, Digital Ocean currently requires the image
+;; to be in zlib mode instead of zstd (which guix outputs
+;; by default) when creating an image using
+;; `guix system image -t qcow2`. In order to fix that image
+;; run the following command:
+;;
+;;     qemu-img convert -O qcow2 -o compression_type=zlib image.qcow2 image_zlib.qcow2
+;;
 (define-module (infiniteadaptability systems digital-ocean)
   #:use-module (gnu)
   #:use-module (gnu packages admin)