doc: Add release notes for the 2.9.0 release

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]>
peknis · Dec 17, 2024 · 3eb9a85 · 3eb9a85
1 parent b0461ac
commit 3eb9a85
Show file tree

Hide file tree

Showing 22 changed files with 711 additions and 115 deletions.
diff --git a/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst b/doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst
@@ -1,4 +1,4 @@
-.. _config_gpio_pin:
+.. _gpio_pin_config:
 
 Driving a GPIO pin directly
 ###########################

diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt
@@ -366,6 +366,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
@@ -425,7 +426,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
@@ -474,6 +476,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
@@ -505,6 +508,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
@@ -533,6 +537,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
@@ -562,6 +567,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
@@ -1548,6 +1554,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

diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst
@@ -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
diff --git a/doc/nrf/releases_and_maturity/known_issues.rst b/doc/nrf/releases_and_maturity/known_issues.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _known_issues:
 
 Known issues

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _ncs_2.0.0_migration:
 
 Migration notes for |NCS| v2.0.0

diff --git a/...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst b/...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst
@@ -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

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.5:
 
 Migration guide for |NCS| v2.5.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.6:
 
 Migration guide for |NCS| v2.6.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.7:
 
 Migration guide for |NCS| v2.7.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_2.8:
 
 Migration guide for |NCS| v2.8.0

diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
@@ -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:
@@ -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
 
@@ -28,49 +26,6 @@ Required changes
 
 The following changes are mandatory to make your application work in the same way as in previous releases.
 
-nRF54H20
-========
-
-This section describes the changes specific to the nRF54H20 SoC and DK support in the |NCS|.
-For more information on changes related to samples and applications usage on the nRF54H20 DK, see :ref:`migration_2.9_required_nrf54h`.
-
-DK compatibility
-----------------
-
-.. toggle::
-
-   * The |NCS| v2.9.0 is compatible only with the Engineering C - v0.8.3 and later revisions of the nRF54H20 DK, PCA10175.
-     The nRF54H20 DK Engineering A and Engineering B (up to v0.8.2) are no longer compatible with the |NCS| v2.9.0.
-
-    Check the version number on your DK's sticker to verify its compatibility with the |NCS|.
-
-Dependencies
-------------
-
-The following required dependencies for the nRF54H20 SoC and DK have been updated.
-
-
-Samples and applications
-========================
-
-This section describes the changes related to samples and applications.
-
-|no_changes_yet_note|
-
-.. _migration_2.9_required_nrf54h:
-
-nRF54H20
---------
-
-|no_changes_yet_note|
-
-Libraries
-=========
-
-This section describes the changes related to libraries.
-
-|no_changes_yet_note|
-
 .. _migration_2.9_recommended:
 
 Recommended changes
@@ -95,10 +50,3 @@ Matter
         Now, this mode is disabled and all Matter watchdog sources must be fed within the specified time window.
 
         To re-enable the pause mode, set the :ref:`CONFIG_NCS_SAMPLE_MATTER_WATCHDOG_PAUSE_IN_SLEEP<CONFIG_NCS_SAMPLE_MATTER_WATCHDOG_PAUSE_IN_SLEEP>` Kconfig option to ``y``.
-
-Libraries
-=========
-
-This section describes the changes related to libraries.
-
-|no_changes_yet_note|
diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7:
 
 Migration notes for |NCS| v2.7.0 and the nRF54H20 DK

diff --git a/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst b/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7.99-cs1:
 
 Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK

diff --git a/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst b/...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _migration_nrf54h20_to_2.7.99-cs2:
 
 Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK

diff --git a/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst b/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _hwmv1_to_v2_migration:
 
 Migrating to the current hardware model

diff --git a/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst b/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _child_parent_to_sysbuild_migration:
 
 Migrating from multi-image builds to sysbuild

diff --git a/doc/nrf/releases_and_maturity/migration_guides.rst b/doc/nrf/releases_and_maturity/migration_guides.rst
@@ -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-exclusive customer sampling releases:
+
+* `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`_
diff --git a/doc/nrf/releases_and_maturity/release_notes.rst b/doc/nrf/releases_and_maturity/release_notes.rst
@@ -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