doc: replace notes on experimental with links

Replaced lengthy mentions of experimental support with links. These now point to the Software Maturity Levels page. Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
nrfconnect · Sep 15, 2022 · 311cd35 · 311cd35
1 parent e121f08
commit 311cd35
Show file tree

Hide file tree

Showing 18 changed files with 35 additions and 30 deletions.
diff --git a/applications/asset_tracker_v2/doc/data_module.rst b/applications/asset_tracker_v2/doc/data_module.rst
@@ -46,7 +46,7 @@ You can alter the default values of the :ref:`Real-time configurations <real_tim
 Connection evaluation
 =====================
 
-This is an experimental feature.
+This is an :ref:`experimental <software_maturity>` feature.
 The module can decide to hold off encoding and sending of sampled data based on evaluation of the LTE connection and estimated energy consumed to send the data.
 This feature is enabled by setting the :ref:`CONFIG_DATA_GRANT_SEND_ON_CONNECTION_QUALITY <CONFIG_DATA_GRANT_SEND_ON_CONNECTION_QUALITY>` Kconfig option.
 The module can deny the sending of data a number of times before it is sent regardless.

diff --git a/applications/matter_weather_station/README.rst b/applications/matter_weather_station/README.rst
@@ -13,7 +13,7 @@ The device works as a Matter accessory device, meaning it can be paired and cont
 You can use this application as a reference for creating your own application.
 
 .. note::
-    The Matter protocol is in an early development stage and must be treated as an experimental feature.
+    The Matter protocol is in an early development stage and must be treated as an :ref:`experimental <software_maturity>` feature.
 
 Requirements
 ************

diff --git a/doc/nrf/app_build_system.rst b/doc/nrf/app_build_system.rst
@@ -46,6 +46,7 @@ You must be aware of these additions when you start writing your own application
 
      warning: Experimental symbol BT_EXT_ADV is enabled.
 
+  For more information, see :ref:`software_maturity`.
 * The |NCS| provides an additional :file:`boilerplate.cmake` that is automatically included when using the Zephyr CMake package in the :file:`CMakeLists.txt` file of your application::
 
     find_package(Zephyr HINTS $ENV{ZEPHYR_BASE})

diff --git a/doc/nrf/doc_build.rst b/doc/nrf/doc_build.rst
@@ -119,7 +119,7 @@ That means that if you do not have local modifications to a documentation set, y
 Downloading is usually quicker than building the documentation from scratch, however, this might depend on your Internet connection speed.
 
 .. note::
-   Using cached builds is currently in an experimental state.
+   Using cached builds is currently in an :ref:`experimental <software_maturity>` state.
 
 To enable the online cache, set the :envvar:`NCS_CACHE_ENABLE` environment variable.
 For example, on Windows, enter the following command::

diff --git a/doc/nrf/libraries/bluetooth_services/services/ddfs.rst b/doc/nrf/libraries/bluetooth_services/services/ddfs.rst
@@ -10,6 +10,9 @@ Direction and Distance Finding Service (DDFS)
 The Bluetooth® LE GATT Direction and Distance Finding Service is a custom service that allows publication of distance, azimuth and elevation measurement data.
 It also allows adjusting the measurement configuration parameters.
 
+.. note::
+   The current implementation is :ref:`experimental <software_maturity>`.
+
 Service UUID
 ************
 

diff --git a/doc/nrf/libraries/networking/azure_fota.rst b/doc/nrf/libraries/networking/azure_fota.rst
@@ -46,7 +46,7 @@ Below are the maximum total fragment sizes in different scenarios:
 It is up to the application that uses the library to restart the device when the FOTA completes and an :c:enumerator:`AZURE_FOTA_EVT_DONE` event is received.
 
 .. note::
-   The current implementation is experimental and may be enhanced in future releases.
+   The current implementation is :ref:`experimental <software_maturity>`.
 
 Configuration
 *************

diff --git a/doc/nrf/libraries/networking/lwm2m_client_utils.rst b/doc/nrf/libraries/networking/lwm2m_client_utils.rst
@@ -54,7 +54,7 @@ Disable the :kconfig:option:`CONFIG_LWM2M_CLIENT_UTILS_DEVICE_OBJ_SUPPORT` Kconf
 If you are using the Firmware Update object and require downloading of firmware images from TLS enabled services like HTTPS, configure :kconfig:option:`CONFIG_LWM2M_CLIENT_UTILS_DOWNLOADER_SEC_TAG` to specify the security tag that has root certificate for the target server.
 
 Location Assistance object (:kconfig:option:`CONFIG_LWM2M_CLIENT_UTILS_LOCATION_ASSIST_OBJ_SUPPORT`) is a proprietary LwM2M object used to deliver information required by various location services through LwM2M.
-It is still under development and considered experimental.
+It is still under development and considered :ref:`experimental <software_maturity>`.
 See the :ref:`location_assistance` section in the LwM2M client sample documentation for more information.
 
 Defining custom objects

diff --git a/doc/nrf/libraries/others/dm.rst b/doc/nrf/libraries/others/dm.rst
@@ -9,6 +9,9 @@ Distance Measurement
 
 The Distance Measurement module provides an integration of :ref:`nrfxlib:nrf_dm` into |NCS|.
 
+.. note::
+   The current implementation is :ref:`experimental <software_maturity>`.
+
 Overview
 ********
 

diff --git a/doc/nrf/releases/release-notes-2.1.0.rst b/doc/nrf/releases/release-notes-2.1.0.rst
@@ -11,9 +11,6 @@
 The SDK includes open source projects (TF-M, MCUboot, OpenThread, Matter, and the Zephyr RTOS), which are continuously integrated and redistributed with the SDK.
 
 Release notes might refer to "experimental" support for features, which indicates that the feature is incomplete in functionality or verification, and can be expected to change in future releases.
-The feature is made available in its current state though the design and interfaces can change between release tags.
-The feature will also be labeled with "EXPERIMENTAL" in Kconfig files to indicate this status.
-Build warnings will be generated to indicate when features labeled EXPERIMENTAL are included in builds unless the Kconfig option :kconfig:option:`CONFIG_WARN_EXPERIMENTAL` is disabled.
 To learn more, see :ref:`software_maturity`.
 
 Highlights

diff --git a/doc/nrf/software_maturity.rst b/doc/nrf/software_maturity.rst
@@ -103,9 +103,6 @@ Matter features support
 
 The following table indicates the software maturity levels of the support for each Matter feature:
 
-.. caution::
-   Matter features are still considered experimental.
-
 .. toggle::
 
   .. sml-table:: matter

diff --git a/doc/nrf/ug_bt_fast_pair.rst b/doc/nrf/ug_bt_fast_pair.rst
@@ -12,7 +12,7 @@ Google also provides additional features built upon the Fast Pair standard.
 For detailed information about supported functionalities, see the official `Fast Pair`_ documentation.
 
 .. note::
-   The Fast Pair support in the |NCS| is experimental.
+   The Fast Pair support in the |NCS| is :ref:`experimental <software_maturity>`.
    The implementation is not yet ready for production and extensions are not supported.
 
    The implementation does not pass end-to-end integration tests in the Fast Pair Validator.

diff --git a/doc/nrf/ug_radio_fem.rst b/doc/nrf/ug_radio_fem.rst
@@ -109,14 +109,11 @@ To perform the split differently (for example, to compensate for external condit
 
 To use FEM power models, set the :kconfig:option:`CONFIG_MPSL_FEM_POWER_MODEL` Kconfig option to ``y``  and either select one of the built-in models or provide a custom model, as described in the following chapters.
 
-Using nRF21540 GPIO SPI built-in power model (Experimental)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Using nRF21540 GPIO SPI built-in power model
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 .. note::
-   The software maturity level of this feature is :ref:`Experimental <software_maturity>`.
-   The feature can be used for development, but it is not recommended for production.
-   This feature is incomplete in functionality or verification and can be expected to change in future releases.
-   The feature is made available in its current state, but the design and interfaces can change between release tags.
-   The feature is also labeled as ``EXPERIMENTAL`` in Kconfig files to indicate this status.
+   This is an :ref:`experimental <software_maturity>` feature.
 
 To use this model, set :kconfig:option:`CONFIG_MPSL_FEM_POWER_MODEL` and :kconfig:option:`CONFIG_MPSL_FEM_POWER_MODEL_NRF21540_USE_BUILTIN` to ``y``.
 

diff --git a/doc/nrf/ug_tfm.rst b/doc/nrf/ug_tfm.rst
@@ -18,7 +18,8 @@ It provides a highly configurable set of software components to create a Trusted
 This is achieved by a set of secure run time services such as Secure Storage, Cryptography, Audit Logs, and Attestation.
 Additionally, secure boot through MCUboot in TF-M ensures integrity of runtime software and supports firmware upgrade.
 
-Support for TF-M with :ref:`minimal version <tfm_minimal_build>` disabled in |NCS| is currently experimental.
+.. note::
+   Support for TF-M with :ref:`minimal version <tfm_minimal_build>` disabled in |NCS| is currently :ref:`experimental <software_maturity>`.
 
 For official documentation, see the `TF-M documentation`_.
 

diff --git a/doc/nrf/ug_zigbee_supported_features.rst b/doc/nrf/ug_zigbee_supported_features.rst
@@ -17,9 +17,9 @@ The stack comes with the following features:
 * Base Device Behavior
 * Devices definitions for devices that were implemented for Zigbee Home Automation and Light Link profiles
 * Zigbee Green Power Proxy Basic
-* Experimental support for ``ZB_ZCL_WWAH``
+* :ref:`Experimental <software_maturity>` support for ``ZB_ZCL_WWAH``
 
-Experimental support means the feature is either not certified or no sample is provided for the given feature (or both).
+Experimental support also means that the feature is either not certified or no sample is provided for the given feature (or both).
 
 See the :ref:`nrfxlib:zboss` page in nrfxlib and the `external ZBOSS development guide and API documentation`_ for more information about the ZBOSS library.
 

diff --git a/samples/bluetooth/nrf_dm/README.rst b/samples/bluetooth/nrf_dm/README.rst
@@ -13,6 +13,10 @@ The Bluetooth® :ref:`ddfs_readme` is running simultaneously.
 
 Sample is configured to use Nordic's SoftDevice link layer.
 
+.. note::
+   The Distance Measurement support in the |NCS| is :ref:`experimental <software_maturity>`.
+   See :ref:`mod_dm` for details.
+
 Requirements
 ************
 

diff --git a/samples/bluetooth/peripheral_fast_pair/README.rst b/samples/bluetooth/peripheral_fast_pair/README.rst
@@ -14,7 +14,7 @@ Google also provides additional features built upon the Fast Pair standard.
 For detailed information about supported functionalities, see the official `Fast Pair`_ documentation.
 
 .. note::
-   The Fast Pair support in the |NCS| is experimental.
+   The Fast Pair support in the |NCS| is :ref:`experimental <software_maturity>`.
    See :ref:`ug_bt_fast_pair` for details.
 
 Requirements

diff --git a/samples/bluetooth/peripheral_uart/README.rst b/samples/bluetooth/peripheral_uart/README.rst
@@ -89,13 +89,15 @@ This build uses the sample-specific UART async adapter module that acts as a bri
 See :ref:`peripheral_uart_sample_activating_variants` for details about how to build the sample with this extension using the :file:`prj_cdc.conf`.
 
 Async adapter experimental module
-   The default sample configuration uses the UART async API.
-   The UART async adapter creates and initializes an instance of the async module.
-   This is needed because the USB CDC ACM implementation provides only the interrupt interface.
-   The adapter uses data provided in the :c:struct:`uart_async_adapter_data` to connect to the UART device that does not use the asynchronous interface.
+---------------------------------
 
-   The module requires the :kconfig:option:`CONFIG_BT_NUS_UART_ASYNC_ADAPTER` to be set to ``y``.
-   For more information about the adapter, see the :file:`uart_async_adapter` source files available in the :file:`peripheral_uart/src` directory.
+The default sample configuration uses the UART async API, which is an :ref:`experimental <software_maturity>` module.
+The UART async adapter creates and initializes an instance of the async module.
+This is needed because the USB CDC ACM implementation provides only the interrupt interface.
+The adapter uses data provided in the :c:struct:`uart_async_adapter_data` to connect to the UART device that does not use the asynchronous interface.
+
+The module requires the :kconfig:option:`CONFIG_BT_NUS_UART_ASYNC_ADAPTER` to be set to ``y``.
+For more information about the adapter, see the :file:`uart_async_adapter` source files available in the :file:`peripheral_uart/src` directory.
 
 MCUboot with serial recovery of the networking core image
 =========================================================

diff --git a/scripts/west_commands/sbom/README.rst b/scripts/west_commands/sbom/README.rst
@@ -11,7 +11,7 @@ The Software Bill of Materials (SBOM) is a :ref:`west <zephyr:west>` extension c
 It provides a list of used licenses for an application build or specific files.
 
 .. note::
-    Generating a list of licenses from an application build is experimental.
+    Generating a list of licenses from an application build is :ref:`experimental <software_maturity>`.
     The accuracy of detection is constantly verified.
     Both implementation and usage may change in the future.