Skip to content

Commit 0bbf7b9

Browse files
authored
Merge pull request #425 from rolfedh/add-previously
Add guidance to avoid using "now" and "previously" in release notes
2 parents 5e60995 + f96ac44 commit 0bbf7b9

File tree

2 files changed

+20
-5
lines changed
  • supplementary_style_guide/glossary_terms_conventions/general_conventions

2 files changed

+20
-5
lines changed

supplementary_style_guide/glossary_terms_conventions/general_conventions/n.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171

7272
*Incorrect forms*: natively-compiled code
7373

74-
*See also*:
74+
*See also*:
7575

7676
[[need]]
7777
==== image:images/yes.png[yes] need (verb)
@@ -189,11 +189,13 @@
189189
*See also*:
190190

191191
[[now]]
192-
==== image:images/yes.png[yes] now (adverb)
193-
*Description*: "Now" means at the present time, immediately, or at once.
192+
==== image:images/caution.png[caution] now (adverb)
193+
*Description*: In most content, you can use "now" when you mean the present time, immediately, or at once.
194194

195-
*Use it*: yes
195+
If your release notes are based on the templates in this guide's xref:release-notes[Release notes] section, use "with this update" rather than "now" to refer to the current release. This is because the temporal context of "now" can cause confusion in release notes that span multiple releases.
196+
197+
*Use it*: with caution
196198

197199
*Incorrect forms*: right now
198200

199-
*See also*:
201+
*See also*: xref:release-notes[Release notes]

supplementary_style_guide/glossary_terms_conventions/general_conventions/p.adoc

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -381,6 +381,19 @@ Use "plugin" rather than "plug-in", unless you are updating existing content tha
381381

382382
*See also*:
383383

384+
[[previously]]
385+
==== image:images/caution.png[caution] Previously (adverb)
386+
*Description*: In most content, you can use "previously" to refer to something that was true or in effect at an earlier time but is no longer true or in effect now.
387+
388+
If your release notes are based on the templates in this guide's xref:release-notes[Release notes] section, use "before this update" rather than "previously" to refer to the current release. This is because the temporal context of "previously" can cause confusion in release notes that span multiple releases.
389+
390+
*Use it*: with caution
391+
392+
*Incorrect forms*:
393+
394+
*See also*: xref:release-notes[Release notes]
395+
396+
384397
// Fuse: Added "In Red Hat Fuse," and moved "in a Camel route" to the end of the sentence
385398
[[processor]]
386399
==== image:images/yes.png[yes] processor (noun)

0 commit comments

Comments
 (0)