(from getambassador.io) Have the release notes images live in the doc…

…s directories
telepresenceio · Aug 4, 2021 · 47b9d40 · 47b9d40
1 parent 6e5c4a4
commit 47b9d40
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/release-notes/telepresence-2.3.4-improved-error.png b/release-notes/telepresence-2.3.4-improved-error.png
diff --git a/release-notes/telepresence-2.3.4-ip-error.png b/release-notes/telepresence-2.3.4-ip-error.png
diff --git a/releaseNotes.yml b/releaseNotes.yml
@@ -19,7 +19,12 @@
 #             is noteworthy.  This is HTML, not plain text or
 #             markdown.  It is handy to use YAML's ">-" feature to
 #             allow line-wrapping.
-#         - image: The URL of an image that visually represents the noteworthy change.
+#         - image: >-
+#             The URL of an image that visually represents the
+#             noteworthy change.  This path is relative to the
+#             `release-notes` directory; if this file is
+#             `FOO/releaseNotes.yml`, then the image paths are
+#             relative to `FOO/release-notes/`.
 #         - docs: The path to the documentation page where additional information can be found.
 
 docTitle: Telepresence Release Notes