docs(compression): fix example and add note (#172)

go-vela · Jun 9, 2023 · 083da87 · 083da87
1 parent 57cde92
commit 083da87
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/DOCS.md b/DOCS.md
@@ -171,10 +171,12 @@ steps:
     parameters:
       registry: index.docker.io
       repo: index.docker.io/octocat/hello-world
-      compression: zstd
-      compression_level: 3
++     compression: zstd
++     compression_level: 3
 ```
 
+> **NOTE:** Be aware that while this may yield better compression and/or performance, many common container tools are not yet compatible with this type of compression. Use at your own risk.
+
 ## Secrets
 
 > **NOTE:** Users should refrain from configuring sensitive information in your pipeline in plain text.