From fdeef2bb18afcbc6b84225a1bb7f86333d380db4 Mon Sep 17 00:00:00 2001 From: divya pillai Date: Thu, 14 Nov 2024 10:42:00 +0100 Subject: [PATCH] doc: post-release doc update for 2.8.0 Standard post-release changes in documentation. Changing version to 2.8.99. Signed-off-by: divya pillai --- doc/nrf/protocols/matter/index.rst | 4 +- doc/nrf/releases_and_maturity.rst | 1 + .../releases_and_maturity/known_issues.rst | 2 - .../migration/migration_guide_1.x_to_2.x.rst | 2 - ...gration_guide_2.4.99-cs3_to_2.6.99-cs2.rst | 2 - .../migration/migration_guide_2.5.rst | 2 - .../migration/migration_guide_2.6.rst | 2 - .../migration/migration_guide_2.7.rst | 2 - .../migration/migration_guide_2.8.rst | 2 - .../migration/migration_guide_2.9.rst | 64 +++++++++++++++++++ .../migration_guide_nRF54H20_cs_to_2_7.rst | 2 - ...ration_guide_nRF54H20_cs_to_2_7_99-cs1.rst | 2 - ...ration_guide_nRF54H20_cs_to_2_7_99-cs2.rst | 2 - .../migration/migration_hwmv2.rst | 2 - .../migration/migration_sysbuild.rst | 2 - .../migration_guides.rst | 19 ++---- .../releases_and_maturity/release_notes.rst | 4 +- .../releases/release-notes-changelog.rst | 13 ++-- doc/versions.json | 1 + 19 files changed, 82 insertions(+), 48 deletions(-) create mode 100644 doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst diff --git a/doc/nrf/protocols/matter/index.rst b/doc/nrf/protocols/matter/index.rst index 7fd50cf893cf..7dc759fda0fb 100644 --- a/doc/nrf/protocols/matter/index.rst +++ b/doc/nrf/protocols/matter/index.rst @@ -23,7 +23,9 @@ For a full list of |NCS| and Matter versions, view the following table: +--------------------------+-----------------------------------------------------+------------------------+ | nRF Connect SDK version | Matter specification version | Matter SDK version | +==========================+=====================================================+========================+ - | |release| | :ref:`1.3.0 ` | 1.3.0.0 | + | v2.8.99 (latest) | :ref:`1.3.0 ` | 1.3.0.0 | + +--------------------------+ | | + | |release| | | | +--------------------------+ | | | v2.7.0 | | | +--------------------------+-----------------------------------------------------+------------------------+ diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst index b492d6eda2d4..1f2f92ae00d2 100644 --- a/doc/nrf/releases_and_maturity.rst +++ b/doc/nrf/releases_and_maturity.rst @@ -28,3 +28,4 @@ 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 index ec103ce8e6c0..19dbd1ae0c0b 100644 --- a/doc/nrf/releases_and_maturity/known_issues.rst +++ b/doc/nrf/releases_and_maturity/known_issues.rst @@ -1,5 +1,3 @@ -: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 index a70e4ccbabe4..d58b1e5db81a 100644 --- 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,5 +1,3 @@ -:orphan: - .. _ncs_2.0.0_migration: Migration notes for |NCS| v2.0.0 diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst index 2fb0f6413515..a5791574fac8 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst @@ -1,5 +1,3 @@ -: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 index b2cac995fd0b..b7f4539c88be 100644 --- 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,5 +1,3 @@ -: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 index a74ee2b8c93f..86f04155e708 100644 --- 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,5 +1,3 @@ -: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 index fea0e6e69baf..6921ef6bee69 100644 --- 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,5 +1,3 @@ -: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 index c98142343767..41062b9e0387 100644 --- 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,5 +1,3 @@ -: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 new file mode 100644 index 000000000000..35c51418034b --- /dev/null +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst @@ -0,0 +1,64 @@ +.. _migration_2.9: + +Migration guide for |NCS| v2.9.0 (Working draft) +################################################ + +.. contents:: + :local: + :depth: 3 + +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 + +.. _migration_2.9_required: + +Required changes +**************** + +The following changes are mandatory to make your application work in the same way as in previous releases. + +Samples and applications +======================== + +This section describes the changes related to samples and applications. + +|no_changes_yet_note| + +Libraries +========= + +This section describes the changes related to libraries. + +|no_changes_yet_note| + +.. _migration_2.9_recommended: + +Recommended changes +******************* + +The following changes are recommended for your application to work optimally after the migration. + +Samples and applications +======================== + +This section describes the changes related to samples and applications. + +|no_changes_yet_note| + +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 index 74fe158b2745..faeeff027ef1 100644 --- 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,5 +1,3 @@ -:orphan: - .. _migration_nrf54h20_to_2.7: Migration notes for |NCS| v2.7.0 and the nRF54H20 DK diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst index 1885f9f2a449..615f6086bf7c 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst @@ -1,5 +1,3 @@ -:orphan: - .. _migration_nrf54h20_to_2.7.99-cs1: Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst index 882d359fac3d..fdc471bc30c7 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst @@ -1,5 +1,3 @@ -: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 index 6689347b3fdf..5568857ddc18 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst @@ -1,5 +1,3 @@ -: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 index f891092a89e1..b813bb468c02 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst @@ -1,5 +1,3 @@ -: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 index 9953a58cf418..d169e313c883 100644 --- a/doc/nrf/releases_and_maturity/migration_guides.rst +++ b/doc/nrf/releases_and_maturity/migration_guides.rst @@ -9,17 +9,10 @@ Migration guides are also provided for major functionality updates. .. note:: |migration_contact_devzone| -* `Migrating from multi-image builds to sysbuild`_ -* `Migrating to the current hardware model`_ -* `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`_ +.. toctree:: + :maxdepth: 1 + :glob: + :reversed: + :caption: Subpages: -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`_ + migration/* diff --git a/doc/nrf/releases_and_maturity/release_notes.rst b/doc/nrf/releases_and_maturity/release_notes.rst index 0dd6e78c1254..3a198e6c171d 100644 --- a/doc/nrf/releases_and_maturity/release_notes.rst +++ b/doc/nrf/releases_and_maturity/release_notes.rst @@ -10,8 +10,9 @@ 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 aspect: + When looking at this latest documentation, be aware of the following aspects: + * 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. @@ -19,6 +20,7 @@ This page is included only in the latest documentation, because it might contain :maxdepth: 1 :caption: Subpages: + releases/release-notes-changelog releases/release-notes-2.8.0 releases/release-notes-2.7.99-cs2 releases/release-notes-2.7.99-cs1 diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst index 46cad5485367..34252a3fb285 100644 --- a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst +++ b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst @@ -1,5 +1,3 @@ -:orphan: - .. _ncs_release_notes_changelog: Changelog for |NCS| v2.8.99 @@ -288,9 +286,6 @@ DECT NR+ samples Edge Impulse samples -------------------- -Edge Impulse samples --------------------- - * :ref:`ei_data_forwarder_sample` sample: * Added support for the :ref:`zephyr:nrf54h20dk_nrf54h20` board. @@ -555,21 +550,21 @@ Zephyr .. NOTE TO MAINTAINERS: All the Zephyr commits in the below git commands must be handled specially after each upmerge and each nRF Connect SDK release. -The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``ea02b93eea35afef32ebb31f49f8e79932e7deee``, with some |NCS| specific additions. +The Zephyr fork in |NCS| (``sdk-zephyr``) contains all commits from the upstream Zephyr repository up to and including ``beb733919d8d64a778a11bd5e7d5cbe5ae27b8ee``, with some |NCS| specific additions. For the list of upstream Zephyr commits (not including cherry-picked commits) incorporated into nRF Connect SDK since the most recent release, run the following command from the :file:`ncs/zephyr` repository (after running ``west update``): .. code-block:: none - git log --oneline ea02b93eea ^23cf38934c + git log --oneline beb733919d ^ea02b93eea For the list of |NCS| specific commits, including commits cherry-picked from upstream, run: .. code-block:: none - git log --oneline manifest-rev ^ea02b93eea + git log --oneline manifest-rev ^beb733919d -The current |NCS| main branch is based on revision ``ea02b93eea`` of Zephyr. +The current |NCS| main branch is based on revision ``beb733919d`` of Zephyr. .. note:: For possible breaking changes and changes between the latest Zephyr release and the current Zephyr version, refer to the :ref:`Zephyr release notes `. diff --git a/doc/versions.json b/doc/versions.json index 92060d798d8f..e0f19e405ca7 100644 --- a/doc/versions.json +++ b/doc/versions.json @@ -1,4 +1,5 @@ [ + "2.8.99", "2.8.0", "2.8.0-preview1", "2.7.99-cs2",