Skip to content

Commit c0874c2

Browse files
authored
(DOCSP-31686): Updated the Release Notes examples to our standards. (#149)
* (DOCSP-31686): Updated the Release Notes examples to our standards. * (DOCSP-31686): Incorporated Chris's feedback. * (DOCS-31686): Incorporated Lindsey's feedback. * (DOCSP-31686): Tweaked guidance to avoid confusion. * (DOCSP-31686): Incorporated Jeff's feedback. * (DOCSP-31686): Incorporated Chris's feedback.
1 parent fcf4df5 commit c0874c2

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

source/style-guide/release-notes-guidelines.txt

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@
44
Release Notes Guidelines
55
========================
66

7-
.. include:: /style-guide/includes/page-needs-update.rst
8-
9-
This topic provides guidelines for writing release notes (RN) for
10-
MongoDB Cloud services APIs.
7+
.. warning::
8+
9+
This page provides general guidance and examples for Release Notes.
10+
Verify the correct and consistent guidelines for each product with
11+
your team.
1112

1213
Follow the Rackspace `Release Guidelines <https://docs.rackspace.com/docs/style-guide/release-notes-guidelines/>`__
1314
from the Rackspace Style Guide.
@@ -158,37 +159,42 @@ Use the following guideline when creating items in each section:
158159
- Use sentences to describe the new feature or enhancement.
159160
Provide as needed, and provide a link to any section in the
160161
documentation that describes that feature.
161-
- IPv6 support has been added. When you create a server, an IPv4
162-
address and an IPv6 address block are assigned. The IPv4 address and
163-
IPv6 address block are used for the public interface (Internet). The
164-
IPv4 address is also used for the private interface.
162+
- Supports IPv6. When you create a server, you can specify
163+
both IPv4 and IPv6 addresses.
165164

166165
* - Resolved issues
167166
- Provide an initial phrase that describes the issue that was
168-
fixed. Start the phrase with a past-tense verb. If necessary,
169-
include sentences to further explain the fix. If you list only
167+
fixed. Start the phrase with a verb. :ref:`Use present tense
168+
<use-present-tense>` or past tense consistently throughout the
169+
release notes. If necessary, include sentences to further
170+
explain the fix and the previous behavior. If you list only
170171
phrases, do not use ending punctuation.
171-
- Added support for Debian 8 (Jessie)
172+
- - Supports Debian 8 (Jessie).
172173

173-
Trimmed the Monitoring ID and Monitoring Token configuration
174-
variables to ensure correctness
174+
- Trims the Monitoring ID and Monitoring Token configuration
175+
variables to ensure correctness.
175176

176-
Fixed the Xen Server 6 package repo
177+
- Fixes the Xen Server 6 package repository to resolve an issue
178+
that caused inconsistencies and errors with package
179+
management.
177180

178181
* - Known issues
179182
- Use sentences to describe the issue. If a workaround is
180183
available, explain it.
181-
- The create a service operation does not support Classless
182-
Inter-Domain Routing (CIDR) for IP address restrictions.
184+
- Results from the ``$indexStats`` operator exclude
185+
queries that use the ``$match`` or ``mapReduce`` functions.
183186

184187
* - Documentation changes
185188
- Provide an initial phrase that describes the issue that was
186-
fixed. Start the phrase with a past-tense verb. If necessary,
187-
include sentences to further explain the fix. If you list only
188-
phrases, do not use ending punctuation. Provide a link to the
189-
relevant section in the documentation.
190-
- Clarified the descriptions of the alert policies to include how
191-
the polling window affects the alarm state.
189+
fixed. Start the phrase with a verb. :ref:`Use present tense
190+
<use-present-tense>` or past tense consistently throughout the
191+
release notes. If necessary, include sentences to further
192+
explain the changes. If you list only phrases, omit ending
193+
punctuation. Provide a link to the relevant section in the
194+
documentation.
195+
- Clarifies the alert policy descriptions to include how
196+
the polling window affects the alarm state. To learn more, see
197+
:atlas:`/alerts/`.
192198

193199
Editing Existing Release Notes
194200
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)