Difference between revisions of "Major release notes"
| Line 6: | Line 6: | ||
[[Archivematica_1.6_release_notes|Archivematica 1.6 Release Notes]]. | [[Archivematica_1.6_release_notes|Archivematica 1.6 Release Notes]]. | ||
| − | == | + | ==Supported environments== |
| − | + | Link to installation instructions. | |
| − | |||
| − | |||
| − | + | Specify supported environments. | |
| − | + | Make special note of any changes to supported environment. | |
| − | == | + | ==Added== |
| − | + | Describe new features. | |
| − | |||
| − | |||
| − | + | ===New feature 1=== | |
| − | |||
| − | + | This is a description of this amazing feature! Here's why it's a net benefit to the project and the community. Also included are any special notes, like if it's a beta feature. | |
| − | + | This work was sponsored by some amazing institution. Thank you! | |
| − | |||
| − | * | + | * Documentation: link |
| − | * | + | * Pull requests: link |
| − | |||
| − | ===New | + | ===New feature 2=== |
| − | + | Here is a description of this amazing feature! Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature. | |
| − | + | This work was sponsored by some amazing institution. Thank you! | |
| − | |||
| − | + | * Documentation: link | |
| + | * Pull requests: link | ||
| + | * Feature files: link | ||
| − | + | ==Changed== | |
| − | + | Describe enhancements or major fixes. | |
| − | === | + | ===Enhancement 1=== |
| − | + | We fixed this issue. Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature. | |
| − | |||
| − | + | This work was sponsored by some amazing institution. Thank you! | |
| − | * | + | * Documentation: link |
| + | * Pull requests: link | ||
| + | * Feature files: link | ||
| − | == | + | ==Fixed== |
| − | * Tool updated to version | + | List bugfixes with a link to the Github issue. |
| + | |||
| + | * Bugfix 1: link | ||
| + | * Bugfix 2: link. Sponsored by someone! | ||
| + | * Bugfix 3: link | ||
| + | |||
| + | ==Upgraded tools and dependencies== | ||
| + | |||
| + | List any tools and dependencies that have been upgraded. | ||
| + | |||
| + | * Tool has been updated to version X. | ||
| + | |||
| + | ==End of life dependencies | ||
| + | |||
| + | List any dependencies that have reached end of life since the last release, as well as a note on the plan going forward. | ||
| + | |||
| + | Make note of any risks, and how users can mitigate them. | ||
Revision as of 12:12, 3 May 2018
Home > Release Notes > Major release notes template
IMPORTANT: only link to Redmine tickets in the public Archivematica project. If no public ticket exists, create a new ticket in the public Archivematica project and link it to the corresponding private ticket.
In the header, include any general notes about the release. For an example, see the Archivematica 1.6 Release Notes.
Supported environments
Link to installation instructions.
Specify supported environments.
Make special note of any changes to supported environment.
Added
Describe new features.
New feature 1
This is a description of this amazing feature! Here's why it's a net benefit to the project and the community. Also included are any special notes, like if it's a beta feature.
This work was sponsored by some amazing institution. Thank you!
- Documentation: link
- Pull requests: link
New feature 2
Here is a description of this amazing feature! Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature.
This work was sponsored by some amazing institution. Thank you!
- Documentation: link
- Pull requests: link
- Feature files: link
Changed
Describe enhancements or major fixes.
Enhancement 1
We fixed this issue. Here's why it's a net benefit to the project and the community, and here is how it will impact your workflow. Also included are any special notes, like if it's a beta feature.
This work was sponsored by some amazing institution. Thank you!
- Documentation: link
- Pull requests: link
- Feature files: link
Fixed
List bugfixes with a link to the Github issue.
- Bugfix 1: link
- Bugfix 2: link. Sponsored by someone!
- Bugfix 3: link
Upgraded tools and dependencies
List any tools and dependencies that have been upgraded.
- Tool has been updated to version X.
==End of life dependencies
List any dependencies that have reached end of life since the last release, as well as a note on the plan going forward.
Make note of any risks, and how users can mitigate them.