doc: update documentation for 2.7.99-cs1

Customer sampling release doc updates. Signed-off-by: Bartosz Gentkowski <bartosz.gentkowski@nordicsemi.no>
nrfconnect · Aug 27, 2024 · 7d4b87f · 7d4b87f
1 parent 3d33b76
commit 7d4b87f
Show file tree

Hide file tree

Showing 20 changed files with 126 additions and 17 deletions.
diff --git a/doc/nrf/conf.py b/doc/nrf/conf.py
@@ -28,7 +28,7 @@
 project = "nRF Connect SDK"
 copyright = "2019-2024, Nordic Semiconductor"
 author = "Nordic Semiconductor"
-version = release = "2.7.99"
+version = release = "2.7.99-cs1"
 
 sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions"))
 sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions"))

diff --git a/doc/nrf/dev_model_and_contributions/adding_code.rst b/doc/nrf/dev_model_and_contributions/adding_code.rst
@@ -162,7 +162,7 @@ This is demonstrated by the following code, that would be placed somewhere in yo
        - name: nrf
          repo-path: sdk-nrf
          remote: ncs
-         revision: 2.7.0
+         revision: 2.7.99-cs1
          import: true
      self:
        path: application
@@ -189,7 +189,7 @@ For example:
      projects:
        - name: nrf
          remote: ncs
-         revision: 2.7.0
+         revision: 2.7.99-cs1
          import: true
        # Example for how to override a repository in the nRF Connect SDK with your own:
        - name: mcuboot

diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt
@@ -327,8 +327,9 @@
 
 .. _`nRF socket options`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrfxlib/nrf_modem/doc/sockets.html
 
-.. _`Repositories and revisions for v2.6.99-cs1`: https://docs.nordicsemi.com/bundle/ncs-2.6.99-cs1/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
 .. _`Repositories and revisions for v2.7.0`: https://docs.nordicsemi.com/bundle/ncs-2.7.0/page/nrf/releases_and_maturity/repository_revisions.html
+.. _`Repositories and revisions for v2.6.99-cs1`: https://docs.nordicsemi.com/bundle/ncs-2.6.99-cs1/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.6.1`: https://docs.nordicsemi.com/bundle/ncs-2.6.1/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.6.0`: https://docs.nordicsemi.com/bundle/ncs-2.6.0/page/nrf/releases_and_maturity/repository_revisions.html
 .. _`Repositories and revisions for v2.5.3`: https://docs.nordicsemi.com/bundle/ncs-2.5.3/page/nrf/releases_and_maturity/repository_revisions.html

diff --git a/doc/nrf/releases_and_maturity.rst b/doc/nrf/releases_and_maturity.rst
@@ -27,4 +27,3 @@ If an issue is found in a release after it has taken place, those issues are lis
    releases_and_maturity/migration_guides
    releases_and_maturity/repository_revisions
    releases_and_maturity/software_maturity
-   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 (Working draft)

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_nrf4h20_to_2.7:
 
 Migration notes for |NCS| v2.7.0 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,14 @@ 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.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.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
@@ -12,15 +12,14 @@ This page is included only in the latest documentation, because it might contain
    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:
 
-   * 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.7.99-cs1
    releases/release-notes-2.7.0
    releases/release-notes-2.6.99-cs2
    releases/release-notes-2.6.99-cs1

diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-2.7.99-cs1.rst b/doc/nrf/releases_and_maturity/releases/release-notes-2.7.99-cs1.rst
@@ -0,0 +1,84 @@
+.. _ncs_release_notes_2799_cs1:
+
+|NCS| v2.7.99-cs1 Release Notes
+###############################
+
+.. contents::
+   :local:
+   :depth: 3
+
+|NCS| v2.7.99-cs1 is a **customer sampling** release, tailored exclusively for participants in the nRF54H20 SoC customer sampling program.
+Do not use this release of |NCS| if you are not participating in the program.
+
+The release is not part of the regular release cycle and is specifically designed to support early adopters working with the nRF54H20 SoC.
+It is intended to provide early access to the latest developments for nRF54H20 SoC, enabling participants to experiment with new features and provide feedback.
+
+The scope of this release is intentionally narrow, concentrating solely on the nRF54H20 DK.
+You can use the latest stable release of |NCS| to work with other boards.
+
+All functionality related to nRF54H20 SoC is considered experimental.
+
+Highlights
+**********
+
+* Added:
+
+  * Support for SAADC.
+  * Clock Control API.
+
+Release tag
+***********
+
+The release tag for the |NCS| manifest repository (|ncs_repo|) is **v2.7.99-cs1**.
+Check the :file:`west.yml` file for the corresponding tags in the project repositories.
+
+To use this release, check out the tag in the manifest repository and run ``west update``.
+See :ref:`cloning_the_repositories` and :ref:`gs_updating_repos_examples` for more information.
+
+For information on the included repositories and revisions, see `Repositories and revisions for v2.7.99-cs1`_.
+
+IDE and tool support
+********************
+
+`nRF Connect extension for Visual Studio Code <nRF Connect for Visual Studio Code_>`_ is the recommended IDE for |NCS| v2.7.99-cs1.
+See the :ref:`installation` section for more information about supported operating systems and toolchain.
+
+.. note::
+
+   Because of the significant, potentially breaking changes introduced in the |NCS| v2.7.0, the support for v2.7.99-cs1 in the |nRFVSC| is experimental in the following areas:
+
+     * sysbuild - During the extension stabilization period, manually edit and verify Kconfig option values instead of using the nRF Kconfig GUI.
+     * Hardware Model v2 - During the extension stabilization period, edit devicetree files manually instead of using the Devicetree Visual Editor.
+       Moreover, custom boards added in the extension will follow the Zephyr's Hardware Model v1.
+
+   The extension users that need v2.7.99-cs1 should `switch to the pre-release version of the extension`_.
+
+Migration notes
+***************
+
+See the :ref:`migration_guides` page for a set of miration guides specifically tailored for the nRF54H20 customer sampling paritipants.
+
+
+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.
+
+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
+
+For the list of |NCS| specific commits, including commits cherry-picked from upstream, run:
+
+.. code-block:: none
+
+   git log --oneline manifest-rev ^ea02b93eea
+
+The current |NCS| main branch is based on revision ``ea02b93eea`` 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>`.
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 .. _ncs_release_notes_changelog:
 
 Changelog for |NCS| v2.7.99

diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt
@@ -1,8 +1,8 @@
 .. |NCS| replace:: nRF Connect SDK
 
-.. |release| replace:: v2.7.0
-.. |release_tt| replace:: ``v2.7.0``
-.. |release_number_tt| replace:: ``2.7.0``
+.. |release| replace:: v2.7.99-cs1
+.. |release_tt| replace:: ``v2.7.99-cs1``
+.. |release_number_tt| replace:: ``2.7.99-cs1``
 
 .. ### Config shortcuts
 

diff --git a/doc/versions.json b/doc/versions.json
@@ -1,5 +1,5 @@
 [
-    "2.7.99",
+    "2.7.99-cs1",
     "2.7.0",
     "2.6.99-cs2",
     "2.6.99-cs1",