Skip to content

Commit

Permalink
doc: Add release notes for the 2.9.0 release
Browse files Browse the repository at this point in the history
Add release notes for NCS v2.9.0 release.

- [ ] Update webinar link
- [ ] Make release notes ready for review
- [ ] Clean changelog
- [ ] Add finalized highlights to the release notes
- [ ] Migration guide cleanup

Signed-off-by: Pekka Niskanen <[email protected]>
  • Loading branch information
peknis committed Dec 11, 2024
1 parent 10edacd commit 8c6ecd3
Show file tree
Hide file tree
Showing 21 changed files with 930 additions and 21 deletions.
10 changes: 9 additions & 1 deletion doc/nrf/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -364,6 +364,7 @@

.. #### Source: www.nordicsemi.com/Events/

.. _`nRF Connect SDK v2.9.0 webinar`:
.. _`nRF Connect SDK v2.8.0 webinar`: https://webinars.nordicsemi.com/events
.. _`nRF Connect SDK v2.7.0 webinar`: https://www.nordicsemi.com/Events/2024/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v270
.. _`nRF Connect SDK v2.6.0 webinar`: https://www.nordicsemi.com/Events/2024/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v260
Expand Down Expand Up @@ -423,7 +424,8 @@
.. _`nRF Connect SDK latest documentation`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/index.html

.. _`known issues page on the main branch`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html
.. _`known issues for nRF Connect SDK v2.8.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/releases_and_maturity/known_issues.html?v=v2-8-0
.. _`known issues for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-9-0
.. _`known issues for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-8-0
.. _`known issues for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-7-0
.. _`known issues for nRF Connect SDK v2.6.2`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-6-2
.. _`known issues for nRF Connect SDK v2.6.1`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/known_issues.html?v=v2-6-1
Expand Down Expand Up @@ -472,6 +474,7 @@

.. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.html

.. _`Repositories and revisions for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.7.99-cs2`: https://docs.nordicsemi.com/bundle/ncs-2.7.99-cs2/page/nrf/releases_and_maturity/repository_revisions.html
.. _`Repositories and revisions for v2.7.99-cs1`: https://docs.nordicsemi.com/bundle/ncs-2.7.99-cs1/page/nrf/releases_and_maturity/repository_revisions.html
Expand Down Expand Up @@ -503,6 +506,7 @@
.. _`Repositories and revisions for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrf/introduction.html#repositories_and_revisions
.. _`Repositories and revisions`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/introduction.html#repositories_and_revisions

.. _`Modem library changelog for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
Expand Down Expand Up @@ -531,6 +535,7 @@
.. _`Modem library changelog for v1.9.1`: https://docs.nordicsemi.com/bundle/ncs-1.9.1/page/nrfxlib/nrf_modem/doc/CHANGELOG.html
.. _`Modem library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrfxlib/nrf_modem/doc/CHANGELOG.html

.. _`LwM2M carrier library changelog for v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-2.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-2.8.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.6.2`: https://docs.nordicsemi.com/bundle/ncs-2.6.2/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
Expand Down Expand Up @@ -560,6 +565,7 @@
.. _`LwM2M carrier library changelog for v1.9.0`: https://docs.nordicsemi.com/bundle/ncs-1.9.0/page/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html


.. _`Migration guide for nRF Connect SDK v2.9.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.9.html
.. _`Migration guide for nRF Connect SDK v2.8.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.8.html
.. _`Migration guide for nRF Connect SDK v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.7.html
.. _`Migration guide for nRF Connect SDK v2.6.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.6.html
Expand Down Expand Up @@ -1544,6 +1550,8 @@

.. ### Source: files.nordicsemi.com

.. _`Twister test report for nRF Connect SDK v2.9.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v2.9.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.9.0/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`Twister test report for nRF Connect SDK v2.8.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.8.0/test-report/twister_test_results_report.html?isNativeBrowsing=true
.. _`Hardware test report for nRF Connect SDK v2.8.0`: https://files.nordicsemi.com/ui/api/v1/download/contentBrowsing/NCS/external/release/v2.8.0/test-report/common_ncs_test_results_report.html?isNativeBrowsing=true
.. _`nRF Auracast configuration files`: https://files.nordicsemi.com/ui/repos/tree/General/ncs-audio/external/nRF-Aura-Config
Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ If an issue is found in a release after it has taken place, those issues are lis
releases_and_maturity/repository_revisions
releases_and_maturity/software_maturity
releases_and_maturity/abi_compatibility
releases_and_maturity/known_issues
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_2.0.0_migration:

Migration notes for |NCS| v2.0.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_2_6_99_cs2:

Migration notes for |NCS| v2.6.99_cs2 for v2.4.99-cs3 users
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.7:

Migration guide for |NCS| v2.7.0
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.8:

Migration guide for |NCS| v2.8.0
Expand Down
10 changes: 4 additions & 6 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
:orphan:

.. _migration_2.9:

Migration guide for |NCS| v2.9.0 (Working draft)
################################################
Migration guide for |NCS| v2.9.0
################################

.. contents::
:local:
Expand All @@ -10,14 +12,10 @@ Migration guide for |NCS| v2.9.0 (Working draft)
This document describes the changes required or recommended when migrating your application from |NCS| v2.8.0 to |NCS| v2.9.0.

.. HOWTO
Add changes in the following format:
Component (for example, application, sample or libraries)
*********************************************************
.. toggle::
* Change1 and description
* Change2 and description
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7:

Migration notes for |NCS| v2.7.0 and the nRF54H20 DK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs1:

Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs2:

Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _hwmv1_to_v2_migration:

Migrating to the current hardware model
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _child_parent_to_sysbuild_migration:

Migrating from multi-image builds to sysbuild
Expand Down
20 changes: 14 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,18 @@ Migration guides are also provided for major functionality updates.
.. note::
|migration_contact_devzone|

.. toctree::
:maxdepth: 1
:glob:
:reversed:
:caption: Subpages:
* `Migrating from multi-image builds to sysbuild`_
* `Migrating to the current hardware model`_
* `Migration guide for nRF Connect SDK v2.9.0`_
* `Migration guide for nRF Connect SDK v2.8.0`_
* `Migration guide for nRF Connect SDK v2.7.0`_
* `Migration guide for nRF Connect SDK v2.6.0`_
* `Migration guide for nRF Connect SDK v2.5.0`_
* `Migration guide for nRF Connect SDK v2.0.0`_

migration/*
For nRF54H20 customer sampling participants:

* `Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`_
* `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_
5 changes: 2 additions & 3 deletions doc/nrf/releases_and_maturity/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ This page is included only in the latest documentation, because it might contain

.. note::
A "99" at the end of the version number of this documentation indicates continuous updates on the main branch since the previous major.minor release.
When looking at this latest documentation, be aware of the following aspects:
When looking at this latest documentation, be aware of the following aspect:

* Changes between releases are tracked on the :ref:`ncs_release_notes_changelog` page, but the main branch might contain additional changes that are not listed on that page.
* The release note pages that are available in the latest documentation might differ slightly from the release notes that were included in the respective |NCS| release at its release date.
Therefore, to see the official version of the release notes for a specific |NCS| release, switch to the documentation for the corresponding |NCS| version using the selector in the upper left corner.

.. toctree::
:maxdepth: 1
:caption: Subpages:

releases/release-notes-changelog
releases/release-notes-2.9.0
releases/release-notes-2.8.0
releases/release-notes-2.7.99-cs2
releases/release-notes-2.7.99-cs1
Expand Down
Loading

0 comments on commit 8c6ecd3

Please sign in to comment.