Release notes structure guidelines¶
The release notes filename should follow the file naming guidelines.
Title¶
| Section | Section guidelines | Example |
|---|---|---|
| Title | Product name and version number (YYYY-MM-DD) | Percona Server for MongoDB 5.0.11-10 (2022-09-01) |
Required sections¶
These sections can be included in the release notes. If you do not have content for these sections, add either “None for this release” or “
The required sections are:
| Section name | Description |
|---|---|
| Date Install Download |
The release date, and links to the product installation doc and the Percona download page |
| Product blurb | No heading required. Based on our Marketing material, this section is a general description of the product benefits. Has information about our professional services. |
| Release highlights | Voice: Active, Present Added features in this release from Percona. A list of features that are now GA as of this release. A list of features that are tech preview A general description of the upstream release notes, including a link. Information about deprecated or removed items. If this is a CVE release, include the following text: This release fixes the security vulnerability CVE Add a link to the CVE page that documents this fix. |
| Bug fixes | Voice: Active, Past A list of bug fixes with links to the Jira ticket. Begin the summary with a past-tense verb. Do not repeat “Fixed”. |
| Useful links | GitHub location Contribute to documentation |
Optional sections¶
Use sentence-style capitalization for headings Use unordered bullet lists for items within a section. If there is only one item, show the item as regular text.
The following sections are optional:
| Optional sections | Description |
|---|---|
| New features | Voice: Active, present New features added by Percona. |
| Improvements | Voice: Active, present Improvements to existing features |
| Deprecated and removed | Voice: Active, present Items that are deprecated or removed in this release. |
| Platform support | Voice: Active, present The platforms that are no longer supported or added to support. List only the relevant information. |
| Documentation changes | Voice: Active, present Additions or updates of significant content to the documentation. |
| Known issues | Voice: Active, present Workaround methods for issues. |
Format¶
Use sentence-style capitalization for headings.
Use unordered bullet lists for items within a section.
If there is only one item, show the item as regular text.
Last update:
June 26, 2023
Created: June 26, 2023
Created: June 26, 2023