From 137bf6ca1f52f080f7dd650fb06da1b61958b14e Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Tue, 24 Oct 2023 08:54:14 -0400 Subject: [PATCH] Add release note section Sidebar entry added for `source/release-notes/release-notes.rst`. Template file also added. This commit will allow review of the format. After being merged, content will be added prior to v92. QA Steps: built and checked html, no issues noted. This commit addresses FFTK-2537 Signed-off-by: Katrina Prosise --- source/index.rst | 7 +++++++ source/release-notes/release-notes.rst | 27 ++++++++++++++++++++++++++ templates/release-notes.rst | 27 ++++++++++++++++++++++++++ 3 files changed, 61 insertions(+) create mode 100644 source/release-notes/release-notes.rst create mode 100644 templates/release-notes.rst diff --git a/source/index.rst b/source/index.rst index 5b226c452..5575362d6 100644 --- a/source/index.rst +++ b/source/index.rst @@ -85,6 +85,13 @@ OE/Yocto Project, the Linux microPlatform™ and Docker®. glossary/index +.. toctree:: + :maxdepth: 1 + :caption: Release Notes + :name: sec-release-notes + + release-notes/release-notes + .. ifconfig:: todo_include_todos is True **Documentation-wide TODO List** diff --git a/source/release-notes/release-notes.rst b/source/release-notes/release-notes.rst new file mode 100644 index 000000000..5c6bb314f --- /dev/null +++ b/source/release-notes/release-notes.rst @@ -0,0 +1,27 @@ +.. _changelog: + +LmP vXX Release Notes +====================== + +Note:: +You can view the full changelog LINK TO CHANGELOG for greater detail + +Important Changes From vXX +--------------------------- + +Quality of life changes which may effect how a customer interacts with a Factory + +Release Highlights +------------------ + +Copy from changelog + +New Features +^^^^^^^^^^^^ + +Hardware Support +^^^^^^^^^^^^^^^^ + +Bug Fixes +^^^^^^^^^ + diff --git a/templates/release-notes.rst b/templates/release-notes.rst new file mode 100644 index 000000000..5c6bb314f --- /dev/null +++ b/templates/release-notes.rst @@ -0,0 +1,27 @@ +.. _changelog: + +LmP vXX Release Notes +====================== + +Note:: +You can view the full changelog LINK TO CHANGELOG for greater detail + +Important Changes From vXX +--------------------------- + +Quality of life changes which may effect how a customer interacts with a Factory + +Release Highlights +------------------ + +Copy from changelog + +New Features +^^^^^^^^^^^^ + +Hardware Support +^^^^^^^^^^^^^^^^ + +Bug Fixes +^^^^^^^^^ +