mirror of
https://github.com/keycloak/keycloak.git
synced 2026-01-06 06:49:53 -06:00
Add templates for release notes and migration guide
Closes #40441 Signed-off-by: Martin Bartoš <mabartos@redhat.com>
This commit is contained in:
4
docs/documentation/release_notes/topics/template.adoc
Normal file
4
docs/documentation/release_notes/topics/template.adoc
Normal file
@@ -0,0 +1,4 @@
|
||||
// Release notes should contain only headline-worthy new features,
|
||||
// assuming that people who migrate will read the upgrading guide anyway.
|
||||
|
||||
= <TODO>
|
||||
@@ -0,0 +1,29 @@
|
||||
// ------------------------ Breaking changes ------------------------ //
|
||||
== Breaking changes
|
||||
|
||||
Breaking changes are identified as requiring changes from existing users to their configurations.
|
||||
In minor or patch releases we will only do breaking changes to fix bugs.
|
||||
|
||||
=== <TODO>
|
||||
|
||||
// ------------------------ Notable changes ------------------------ //
|
||||
== Notable changes
|
||||
|
||||
Notable changes where an internal behavior changed to prevent common misconfigurations, fix bugs or simplify running {project_name}.
|
||||
|
||||
=== <TODO>
|
||||
|
||||
// ------------------------ Deprecated features ------------------------ //
|
||||
== Deprecated features
|
||||
|
||||
The following sections provide details on deprecated features.
|
||||
|
||||
=== <TODO>
|
||||
|
||||
// ------------------------ Removed features ------------------------ //
|
||||
== Removed features
|
||||
|
||||
The following features have been removed from this release.
|
||||
|
||||
=== <TODO>
|
||||
|
||||
Reference in New Issue
Block a user