Releases document the changes that are applied to a published version of a service.
Properties
The document type release provides the following properties:
Type
Specify the type of the release to organize them.
Use the Release Type to define types of releases.
Assets
List the assets created and published by this release.
Version
Provide the version of the release.
Release Date
Specify the date of the release.
Previous Release
Specify a link to the previous release.
Next Release
Specify a link to the next release.
Sections
Description
Describe the purpose of this release.
You may add also information about the product to help readers to determine, if this release is relevant for them.
Summary
List the main features of this release and the most important information for users.
New and Noteworthy
Describe the most interesting changes in more detail.
Requirements
List requirements for the new version of the product.
Breaking Changes
Describe changes that remove or break existing features that require the user's attention.
Known Issues
List known issues with this release and provide workarounds and links to track the issues.
List of Changes
List all changes of this release.
This is an automatic list.
Notes
These are internal notes that are usually not exported and only visible to team members with write access.
But this is not a safe place to store sensible information. It is just a convenience for the reader to not be bothered with notes stored here for the authors for later use. The security level is about suppressing the representation by a CSS style. Therefore consider this as a convenience for the reader, not as a security tool.
References
For a document the references section contains pointers to resources that prove the statements of the document.
Often these proofs are not easily distinguishable from further information. In this case you may want to skip the reference section in favour for the resource list.
Resources
The resources section provides references to further information to the topic of the document.
This may be information on the internet provided by the resource or information in the team's information systems. Anything the reader of the resource might want to know, may be listed here.
