doc: Add admonitions that ATv2 is in maintenance mode

divipillai · rlubos · commit 5319a8cbfa38 · 2024-10-10T15:17:34.000+02:00
Add admonitions that ATv2 is in maintenance mode
and to use the the nRF Cloud multi-service sample

request from Goluboff, Mariano

Signed-off-by: divya pillai &lt;divya.pillai@nordicsemi.no&gt;
diff --git a/applications/asset_tracker_v2/README.rst b/applications/asset_tracker_v2/README.rst
@@ -7,7 +7,10 @@ Asset Tracker v2
    :local:
    :depth: 2
 
-The Asset Tracker v2 is a real-time configurable ultra-low power capable application firmware for the nRF91 Series :term:`System in Package (SiP)`.
+.. important::
+   |ATv2_maintenance_note|
+
+Asset Tracker v2 is a real-time configurable ultra-low power capable application firmware for the nRF91 Series :term:`System in Package (SiP)`.
 
 See the subpages for detailed documentation on the application and its modules:
 
diff --git a/applications/asset_tracker_v2/doc/app_behavior.rst b/applications/asset_tracker_v2/doc/app_behavior.rst
@@ -7,6 +7,9 @@ Application behavior and functionality
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 This section describes the general functioning of the Asset Tracker v2 application.
 
 Data types
diff --git a/applications/asset_tracker_v2/doc/app_module.rst b/applications/asset_tracker_v2/doc/app_module.rst
@@ -7,6 +7,9 @@ Application module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The application module controls key mechanisms in the Asset Tracker v2.
 It decides when to sample data, what types of data to sample, and has explicit control over some aspects of the application.
 
diff --git a/applications/asset_tracker_v2/doc/asset_tracker_v2_description.rst b/applications/asset_tracker_v2/doc/asset_tracker_v2_description.rst
@@ -7,6 +7,9 @@ Application description
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The Asset Tracker v2 application is built on the following principles:
 
 * Ultra-low power by design - The application highlights the power saving features of the nRF91 Series SiP, which is critical for successfully developing small form-factor devices and products which need very long battery lifetime.
diff --git a/applications/asset_tracker_v2/doc/cloud_module.rst b/applications/asset_tracker_v2/doc/cloud_module.rst
@@ -7,6 +7,9 @@ Cloud module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The cloud module establishes and maintains the connection to a supported cloud service.
 It uses the :ref:`Cloud wrapper API <api_cloud_wrapper>` to integrate and handle the client libraries present in the |NCS|.
 
diff --git a/applications/asset_tracker_v2/doc/cloud_wrapper.rst b/applications/asset_tracker_v2/doc/cloud_wrapper.rst
@@ -7,6 +7,9 @@ Cloud wrapper API
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The cloud wrapper API is a generic API used for controlling the connection to a supported |NCS| client library through :ref:`Integration layers <integration_layers>`.
 It exposes generic functions such as ``send``, ``connect``, and ``disconnect``, hiding the functionality that is specific to a single client library implementation.
 
diff --git a/applications/asset_tracker_v2/doc/data_module.rst b/applications/asset_tracker_v2/doc/data_module.rst
@@ -7,6 +7,9 @@ Data module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The data module gathers data that has been sampled by other modules in the system and stores it into ring buffers.
 It keeps track of data requested by the :ref:`asset_tracker_v2_app_module` and decides when data is sent to the cloud.
 
diff --git a/applications/asset_tracker_v2/doc/debug_module.rst b/applications/asset_tracker_v2/doc/debug_module.rst
@@ -7,6 +7,9 @@ Debug module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The debug module intends to improve the overall debugging experience in the application.
 By default, it subscribes to all the events in the system and implements support for `Memfault`_ through the :ref:`mod_memfault` module integrated in |NCS|.
 
diff --git a/applications/asset_tracker_v2/doc/firmware_architecture.rst b/applications/asset_tracker_v2/doc/firmware_architecture.rst
@@ -7,6 +7,9 @@ Firmware architecture
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The Asset Tracker v2 application has a modular structure, where each module has a defined scope of responsibility.
 The application makes use of the :ref:`app_event_manager` to distribute events between modules in the system.
 The Application Event Manager is used for all the communication between the modules.
diff --git a/applications/asset_tracker_v2/doc/location_module.rst b/applications/asset_tracker_v2/doc/location_module.rst
@@ -7,6 +7,9 @@ Location module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The location module controls the GNSS, cellular and Wi-Fi positioning functionality.
 It can be used to retrieve the location of the device in the form of events containing a position, velocity and time (PVT) structure.
 
diff --git a/applications/asset_tracker_v2/doc/lwm2m_carrier_library.rst b/applications/asset_tracker_v2/doc/lwm2m_carrier_library.rst
@@ -3,6 +3,10 @@
 Using the carrier library
 #########################
 
+.. important::
+   |ATv2_maintenance_note|
+
+
 .. |application_sample_name| replace:: Asset Tracker v2 application
 
 .. include:: /includes/lwm2m_carrier_library.txt
diff --git a/applications/asset_tracker_v2/doc/modem_module.rst b/applications/asset_tracker_v2/doc/modem_module.rst
@@ -7,6 +7,9 @@ Modem module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The modem module communicates with the modem to control the LTE connection and retrieve information from the modem about the device and LTE network.
 
 Features
diff --git a/applications/asset_tracker_v2/doc/modules.rst b/applications/asset_tracker_v2/doc/modules.rst
@@ -3,6 +3,10 @@
 Application modules
 ###################
 
+.. important::
+   |ATv2_maintenance_note|
+
+
 The Asset Tracker v2 application consists of a set of modules.
 See :ref:`asset_tracker_v2_architecture` for more information on how the application is structured.
 
diff --git a/applications/asset_tracker_v2/doc/modules_common.rst b/applications/asset_tracker_v2/doc/modules_common.rst
@@ -7,6 +7,9 @@ Modules common API
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The Modules common API provides the functionality to administer mechanisms in the application architecture, and consist of functions that are shared between modules.
 The API supports the following functionalities:
 
diff --git a/applications/asset_tracker_v2/doc/sensor_module.rst b/applications/asset_tracker_v2/doc/sensor_module.rst
@@ -7,6 +7,9 @@ Sensor module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The sensor module interacts with external sensors present on the `Thingy:91 <Thingy\:91 product page_>`_ and Thingy:91 X.
 It collects environmental data and detects motion over a set threshold value.
 
diff --git a/applications/asset_tracker_v2/doc/ui_module.rst b/applications/asset_tracker_v2/doc/ui_module.rst
@@ -7,6 +7,9 @@ User Interface module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The User Interface module controls and monitors the UI elements on nRF91 Series development kits, Thingy:91, and Thingy:91 X.
 
 Features
diff --git a/applications/asset_tracker_v2/doc/unit_test.rst b/applications/asset_tracker_v2/doc/unit_test.rst
@@ -7,6 +7,9 @@ Unit tests
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The internal modules of the :ref:`asset_tracker_v2` application have a set of unit tests in the :file:`asset_tracker_v2/tests` folder.
 Following are the modules that have unit tests:
 
diff --git a/applications/asset_tracker_v2/doc/util_module.rst b/applications/asset_tracker_v2/doc/util_module.rst
@@ -7,6 +7,9 @@ Utility module
    :local:
    :depth: 2
 
+.. important::
+   |ATv2_maintenance_note|
+
 The utility module provides the functionality to administer and monitor mechanisms in the application architecture.
 
 Features
diff --git a/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst b/doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
@@ -225,7 +225,7 @@ Machine learning
 Asset Tracker v2
 ----------------
 
-|no_changes_yet_note|
+* Added a note that the :ref:`asset_tracker_v2` application is in the maintenance mode and recommended to use the :ref:`nrf_cloud_multi_service` sample instead.
 
 Connectivity Bridge
 -------------------
diff --git a/doc/nrf/shortcuts.txt b/doc/nrf/shortcuts.txt
@@ -239,3 +239,6 @@
 
 .. |nrf54_buttons_leds_numbering| replace:: The nRF54 DKs use a different numbering pattern for LED and buttons.
    See the User interface section for full overview.
+
+.. |ATv2_maintenance_note| replace:: The Asset Tracker v2 application is in maintenance mode.
+   For new projects, it is recommended to use the :ref:`nrf_cloud_multi_service` sample instead.
