Get the release notes pages working

telepresenceio · Jun 9, 2021 · 77f8486 · 77f8486
1 parent 61edc91
commit 77f8486
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 4 deletions.
diff --git a/release-notes/no-ssh.png b/release-notes/no-ssh.png
diff --git a/release-notes/run-tp-in-docker.png b/release-notes/run-tp-in-docker.png
diff --git a/release-notes/telepresence-2.2.png b/release-notes/telepresence-2.2.png
diff --git a/release-notes/telepresence-2.3.0-homebrew.png b/release-notes/telepresence-2.3.0-homebrew.png
diff --git a/release-notes/telepresence-2.3.0-loglevels.png b/release-notes/telepresence-2.3.0-loglevels.png
diff --git a/release-notes/tunnel.jpg b/release-notes/tunnel.jpg
diff --git a/releaseNotes.yml b/releaseNotes.yml
@@ -1,5 +1,9 @@
-# This file should be placed in the folder for the version of the product that's meant to be documented. A `/release-notes` page will be automatically generated and populated at build time.
-# Note that an entry needs to be added to the `doc-links.yml` file in order to surface the release notes in the table of contents.
+# This file should be placed in the folder for the version of the
+# product that's meant to be documented. A `/release-notes` page will
+# be automatically generated and populated at build time.
+#
+# Note that an entry needs to be added to the `doc-links.yml` file in
+# order to surface the release notes in the table of contents.
 #
 # The YAML in this file should contain:
 #
@@ -10,20 +14,29 @@
 #     - notes: An array of noteworthy changes included in the release, each having the following attributes:
 #         - title: A short title of the noteworthy change.
 #         - body: Two or three sentences describing the change and why it is noteworthy. This is in rich text format and may contain HTML elements.
-#         - image: The URL of an image that visually represents the noteworthy change. This can be an absolute path or the name of the image file placed under the `ambassador-docs/public` folder starting with `./` (e.g., `./ambassador-example.png`).
+#         - image: The URL of an image that visually represents the noteworthy change.
 #         - docs: The path to the documentation page where additional information can be found.
 #         - type: The type of change, one of `bugfix`, `feature`, `security` or `change`.
 #
 
+docTitle: Telepresence Release Notes
+docDescription: >-
+  Release notes for Telepresence by Ambassador Labs, a CNCF project
+  that enables developers to iterate rapidly on Kubernetes
+  microservices by arming them with infinite-scale development
+  environments, access to instantaneous feedback loops, and highly
+  customizable development environments.
+
 changelog: https://github.com/telepresenceio/telepresence/blob/$branch$/CHANGELOG.md
+
 items:
   - version: 2.3.0
     date: '2021-06-01'
     notes:
       - title: Brew install Telepresence
         body: "Telepresence can now be installed via brew on macOS, which makes it easier for users to stay up-to-date with the latest telepresence version. To install via brew, you can use the following command: <code>brew install datawire/blackbird/telepresence2</code>."
         image: ./telepresence-2.3.0-homebrew.png
-        docs: install/index/
+        docs: install/
         type: feature
       - title: TCP and UDP routing via Virtual Network Interface
         body: "Telepresence will now perform routing of outbound TCP and UDP traffic via a Virtual Network Interface (VIF). The VIF is a layer 3 TUN-device that exists while Telepresence is connected. It makes the subnets in the cluster available to the workstation and will also route DNS requests to the cluster and forward them to intercepted pods. This means that pods with custom DNS configuration will work as expected. Prior versions of Telepresence would use firewall rules and were only capable of routing TCP."