Add documentation for the prefixStagePaths parameter

guardian · Mar 3, 2023 · bd07952 · bd07952
1 parent fc96b80
commit bd07952
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala b/magenta-lib/src/main/scala/magenta/deployment_type/S3ObjectPrefixParameters.scala
@@ -30,6 +30,15 @@ trait S3ObjectPrefixParameters {
   val prefixStagePaths: Param[Map[String, String]] = Param[Map[String, String]](
     "prefixStagePaths",
     documentation = """
+        |This option allows full control over the paths used for each stage, and will override all other prefix options.
+        |
+        |This is a useful escape hatch if you find yourself in a scenario where you are deploying to a single bucket and
+        |the upload path between stages cannot be repeated.
+        |
+        |**Note:** For the most part, you should not use this.
+        |If at all possible, prefer to use a single bucket per-stage.
+        |
+        |See our recommendation here: https://github.com/guardian/recommendations/blob/main/AWS.md?plain=1#L70
         |```yaml
         |prefixStagePaths:
         |  CODE: atoms-CODE