|
4 | 4 | Release Notes Guidelines |
5 | 5 | ======================== |
6 | 6 |
|
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. |
11 | 12 |
|
12 | 13 | Follow the Rackspace `Release Guidelines <https://docs.rackspace.com/docs/style-guide/release-notes-guidelines/>`__ |
13 | 14 | from the Rackspace Style Guide. |
@@ -158,37 +159,42 @@ Use the following guideline when creating items in each section: |
158 | 159 | - Use sentences to describe the new feature or enhancement. |
159 | 160 | Provide as needed, and provide a link to any section in the |
160 | 161 | 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. |
165 | 164 |
|
166 | 165 | * - Resolved issues |
167 | 166 | - 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 |
170 | 171 | phrases, do not use ending punctuation. |
171 | | - - Added support for Debian 8 (Jessie) |
| 172 | + - - Supports Debian 8 (Jessie). |
172 | 173 |
|
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. |
175 | 176 |
|
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. |
177 | 180 |
|
178 | 181 | * - Known issues |
179 | 182 | - Use sentences to describe the issue. If a workaround is |
180 | 183 | 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. |
183 | 186 |
|
184 | 187 | * - Documentation changes |
185 | 188 | - 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/`. |
192 | 198 |
|
193 | 199 | Editing Existing Release Notes |
194 | 200 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
0 commit comments