What should be highlighted
- Any changes to configuration files
- Any changes to metatypes
- Core taxonomy changes
- Query/federation changes
- Changes that can impact the entire system (for example, adding the Security Manager)
What information should be provided
- What changed?
- What's the potential impact?
- What do users need to do differently now? (reference workarounds, mitigations, or migration instructions)
The release notes are divided into functional sections that can guide users to the types of information they are looking for. These guidelines can help developers know where to capture changes. Many of the sections include Jira queries which can link users to more detailed information.
New features included in this version should be listed here when they are potentially of interest to users looking to adopt or upgrade.
This section captures bug fixes available in this version
List any upgrades to dependencies here.
This section is a great resource for known issues that arise after a release to provide workaround steps or mitigations users should take. This is likely the only section that would need editing post-release.
List applications, endpoints, or other components that will be marked deprecated in this version.