Skip to content

Commit

Permalink
doc: post-release doc update for 2.8.0
Browse files Browse the repository at this point in the history
Standard post-release changes in documentation.
Changing version to 2.8.99.

Signed-off-by: divya pillai <[email protected]>
  • Loading branch information
divipillai authored and rlubos committed Nov 14, 2024
1 parent 9598724 commit 811c806
Show file tree
Hide file tree
Showing 19 changed files with 82 additions and 48 deletions.
4 changes: 3 additions & 1 deletion doc/nrf/protocols/matter/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <ug_matter_overview_dev_model_support>` | 1.3.0.0 |
| v2.8.99 (latest) | :ref:`1.3.0 <ug_matter_overview_dev_model_support>` | 1.3.0.0 |
+--------------------------+ | |
| |release| | | |
+--------------------------+ | |
| v2.7.0 | | |
+--------------------------+-----------------------------------------------------+------------------------+
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/releases_and_maturity.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 0 additions & 2 deletions doc/nrf/releases_and_maturity/known_issues.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
: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,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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. _migration_2.5:

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

.. _migration_2.6:

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

.. _migration_2.7:

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

.. _migration_2.8:

Migration guide for |NCS| v2.8.0
Expand Down
64 changes: 64 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
Original file line number Diff line number Diff line change
@@ -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|
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
: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,5 +1,3 @@
: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,5 +1,3 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs2:

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

.. _hwmv1_to_v2_migration:

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

.. _child_parent_to_sysbuild_migration:

Migrating from multi-image builds to sysbuild
Expand Down
19 changes: 6 additions & 13 deletions doc/nrf/releases_and_maturity/migration_guides.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/*
4 changes: 3 additions & 1 deletion doc/nrf/releases_and_maturity/release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,17 @@ 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.

.. toctree::
: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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
:orphan:

.. _ncs_release_notes_changelog:

Changelog for |NCS| v2.8.99
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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 <zephyr_release_notes>`.
Expand Down
1 change: 1 addition & 0 deletions doc/versions.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[
"2.8.99",
"2.8.0",
"2.8.0-preview1",
"2.7.99-cs2",
Expand Down

0 comments on commit 811c806

Please sign in to comment.