Skip to content

Commit

Permalink
Add release note section
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
kprosise committed Oct 24, 2023
1 parent b26edc1 commit 137bf6c
Show file tree
Hide file tree
Showing 3 changed files with 61 additions and 0 deletions.
7 changes: 7 additions & 0 deletions source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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**
Expand Down
27 changes: 27 additions & 0 deletions source/release-notes/release-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _changelog:

LmP vXX Release Notes

Check failure on line 3 in source/release-notes/release-notes.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Header-cap] 'LmP vXX Release Notes': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case Raw Output: {"message": "[Fio-docs.Header-cap] 'LmP vXX Release Notes': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case", "location": {"path": "source/release-notes/release-notes.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "ERROR"}
======================

Note::
You can view the full changelog LINK TO CHANGELOG for greater detail

Important Changes From vXX

Check failure on line 9 in source/release-notes/release-notes.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Header-cap] 'Important Changes From vXX': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case Raw Output: {"message": "[Fio-docs.Header-cap] 'Important Changes From vXX': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case", "location": {"path": "source/release-notes/release-notes.rst", "range": {"start": {"line": 9, "column": 1}}}, "severity": "ERROR"}
---------------------------

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
^^^^^^^^^

27 changes: 27 additions & 0 deletions templates/release-notes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
.. _changelog:

LmP vXX Release Notes

Check failure on line 3 in templates/release-notes.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Header-cap] 'LmP vXX Release Notes': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case Raw Output: {"message": "[Fio-docs.Header-cap] 'LmP vXX Release Notes': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case", "location": {"path": "templates/release-notes.rst", "range": {"start": {"line": 3, "column": 1}}}, "severity": "ERROR"}
======================

Note::
You can view the full changelog LINK TO CHANGELOG for greater detail

Important Changes From vXX

Check failure on line 9 in templates/release-notes.rst

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [Fio-docs.Header-cap] 'Important Changes From vXX': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case Raw Output: {"message": "[Fio-docs.Header-cap] 'Important Changes From vXX': Use APA title case: https://apastyle.apa.org/style-grammar-guidelines/capitalization/title-case", "location": {"path": "templates/release-notes.rst", "range": {"start": {"line": 9, "column": 1}}}, "severity": "ERROR"}
---------------------------

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
^^^^^^^^^

0 comments on commit 137bf6c

Please sign in to comment.