Skip to content

Commit d42da23

Browse files
authored
docs(chore): fix a few more nits in the release notes templates (#2252)
* docs(chore): fix a few more nits in the release notes templates * add comment about LTS or Feature in title
1 parent 200b9cd commit d42da23

File tree

2 files changed

+13
-10
lines changed

2 files changed

+13
-10
lines changed

templates/spinnaker-prerelease-release-notes.tmpl

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ description: >
88

99
---
1010

11-
## {{ (time.Now).Format "2006/01/02" }} Release Notes
11+
## {{ (time.Now).Format "2006/01/02" }} release notes
1212

1313
## Disclaimer
1414

@@ -31,7 +31,7 @@ You acknowledge that Armory has provided the Services in reliance upon the limit
3131

3232
## Required Armory Operator version
3333

34-
To install, upgrade, or configure Armory {{ (ds "payload").armoryVersion }}, use Armory Operator 1.70 or later.
34+
To install, upgrade, or configure Armory CD {{ (ds "payload").armoryVersion }}, use Armory Operator 1.70 or later.
3535

3636
## Security
3737

@@ -65,8 +65,7 @@ There have also been numerous enhancements, fixes, and features across all of Sp
6565

6666
### Bill Of Materials (BOM)
6767

68-
Here's the BOM for this version.
69-
<details><summary>Expand</summary>
68+
<details><summary>Expand to see the BOM</summary>
7069
<pre class="highlight">
7170
<code>{{ (ds "payload").stack | data.ToYAML }}</code>
7271
</pre>

templates/spinnaker-release-notes.tmpl

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,21 @@ toc_hide: true
44
version: <!-- version in 00.00.00 format ex 02.23.01 for sorting, grouping -->
55
date: {{ (time.Now).Format "2006-01-02" }}
66
description: >
7-
Release notes for Armory Continuous Deployment v{{ (ds "payload").armoryVersion }}
7+
Release notes for Armory Continuous Deployment v{{ (ds "payload").armoryVersion }}.
88
---
99

10-
## {{ (time.Now).Format "2006/01/02" }} Release Notes
10+
<!--
11+
MAKE SURE TO ADD 'LTS' OR 'FEATURE' TO THE TITLE TO INDICATE RELEASE CATEGORY.
12+
FOR EXAMPLE, "Armory Continuous Deployment Release LTS" or "Armory Continuous Deployment Release Feature" so users know release category and support time period
13+
-->
14+
15+
## {{ (time.Now).Format "2006/01/02" }} release notes
1116

12-
> Note: If you're experiencing production issues after upgrading Spinnaker, rollback to a previous working version and please report issues to [http://go.armory.io/support](http://go.armory.io/support).
17+
>Note: If you experience production issues after upgrading Armory Continuous Deployment, roll back to a previous working version and report issues to [http://go.armory.io/support](http://go.armory.io/support).
1318

1419
## Required Armory Operator version
1520

16-
To install, upgrade, or configure Armory {{ (ds "payload").armoryVersion }}, use Armory Operator 1.70 or later.
21+
To install, upgrade, or configure Armory CD {{ (ds "payload").armoryVersion }}, use Armory Operator 1.70 or later.
1722

1823
## Security
1924

@@ -47,8 +52,7 @@ There have also been numerous enhancements, fixes, and features across all of Sp
4752

4853
### Bill Of Materials (BOM)
4954

50-
Here's the BOM for this version.
51-
<details><summary>Expand</summary>
55+
<details><summary>Expand to see the BOM</summary>
5256
<pre class="highlight">
5357
<code>{{ (ds "payload").stack | data.ToYAML }}</code>
5458
</pre>

0 commit comments

Comments
 (0)