Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add 2.1.0 release doc updates #8510

Merged
merged 5 commits into from
Sep 15, 2022
+1,217 −775
Merged

doc: add 2.1.0 release doc updates #8510

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7497d61
doc: add 2.1.0 release doc updates
greg-fer Sep 14, 2022
4de1f92
doc: add release notes for 2.1.0
greg-fer Sep 5, 2022
24f20ca
doc: clean changelog for 2.1.0
greg-fer Sep 5, 2022
936c26b
doc: last-minute pre-release doc fixes
greg-fer Sep 9, 2022
2b18bab
doc: replace notes on experimental with links
greg-fer Sep 13, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion applications/asset_tracker_v2/doc/data_module.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion applications/matter_weather_station/README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
************
Expand Down
1 change: 1 addition & 0 deletions doc/nrf/app_build_system.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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})
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
project = "nRF Connect SDK"
copyright = "2019-2022, Nordic Semiconductor"
author = "Nordic Semiconductor"
version = release = "2.0.99"
version = release = "2.1.0"

sys.path.insert(0, str(ZEPHYR_BASE / "doc" / "_extensions"))
sys.path.insert(0, str(NRF_BASE / "doc" / "_extensions"))
Expand Down
8 changes: 4 additions & 4 deletions doc/nrf/dm_adding_code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ All workflows are described under the following basic assumptions:
* The term *application* refers to the application code and any board definitions and libraries it requires.
* The application(s) will require updates of the |NCS| revision.

Workflow 1: Eschew Git and west
===============================
Workflow 1: Avoid Git and west
==============================

If you have your own version control tools, you might want to simply not use Git or west at all, and instead rely on your own toolset.
In such case, you must obtain a copy of the |NCS| on your file system and then manage the source code of both the SDK and your application yourself.
Expand Down Expand Up @@ -92,7 +92,7 @@ This is demonstrated by the following code:
- name: nrf
repo-path: sdk-nrf
remote: ncs
revision: v2.0.2
revision: v2.1.0
import: true
self:
path: application
Expand All @@ -119,7 +119,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: v2.0.2
revision: v2.1.0
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/doc_build.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
3 changes: 2 additions & 1 deletion doc/nrf/includes/build_and_run.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
This sample can be found under |sample path| in the |NCS| folder structure.

See :ref:`gs_programming` for information about how to build and program the application and :ref:`gs_testing` for general information about testing and debugging in the |NCS|.
To build the sample with |VSC|, follow the steps listed on the `Building nRF Connect SDK application quick guide`_ page in the |nRFVSC| documentation.
See :ref:`gs_programming` for other building and programming scenarios and :ref:`gs_testing` for general information about testing and debugging in the |NCS|.
3 changes: 2 additions & 1 deletion doc/nrf/includes/build_and_run_ns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ This sample can be found under |sample path| in the |NCS| folder structure.

When built as a non-secure firmware image for the ``_ns`` build target, the sample automatically includes the :ref:`Trusted Firmware-M <ug_tfm>` (TF-M).

See :ref:`gs_programming` for information about how to build and program the application and :ref:`gs_testing` for general information about testing and debugging in the |NCS|.
To build the sample with |VSC|, follow the steps listed on the `Building nRF Connect SDK application quick guide`_ page in the |nRFVSC| documentation.
See :ref:`gs_programming` for other building and programming scenarios and :ref:`gs_testing` for general information about testing and debugging in the |NCS|.
23 changes: 1 addition & 22 deletions doc/nrf/includes/vsc_build_and_run.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,4 @@

If you installed the |NCS| using the :ref:`gs_app_tcm`, you can click the :guilabel:`Open VS Code` button next to the version you installed.

#. Open the |nRFVSC| by clicking its icon or pressing ``Ctrl`` + ``Alt`` + ``N``.
#. Click the :guilabel:`Add an existing application` from the :guilabel:`Welcome View`.
#. In the prompt, navigate to the folder containing the sample or application you want to build, such as |sample_path_vsc|.

Samples are located under :file:`nrf/samples/`, and applications are located under :file:`nrf/applications/`.

#. Click :guilabel:`Select folder` to select the sample's or the application's folder.

A new application is automatically added in the :guilabel:`Applications View`.

#. If needed, click :guilabel:`Yes` when prompted if you trust the authors of the files.
#. Click the :guilabel:`Add Build Configuration` button in the :guilabel:`Application View`, or click the text stating :guilabel:`No build configurations. Click to create one`.

This opens the :guilabel:`Add Build Configuration` screen.

#. Select the board onto which you want to program the sample.
In this case, |vsc_sample_board_target_line|.
#. Select the :guilabel:`Build after generating configuration` checkbox and click the :guilabel:`Build Configuration` button.

This generates the configuration file and triggers the build process.
When the process is complete, the :guilabel:`Actions View` appears.
In this View, you can trigger the build process again, flash the built sample, or start a debug session.
#. Complete the steps listed on the `Building nRF Connect SDK application quick guide`_ page in the |nRFVSC| documentation.
1 change: 0 additions & 1 deletion doc/nrf/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ A "99" at the end of the version number of this documentation indicates continuo
libraries/index
scripts
release_notes
known_issues
software_maturity
documentation

Expand Down
4 changes: 4 additions & 0 deletions doc/nrf/known_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down Expand Up @@ -156,6 +158,8 @@ Serial LTE Modem
NCSDK-13895: Build failure for target Thingy:91 with secure_bootloader overlay
Building the application for Thingy:91 fails if secure_bootloader overlay is included.

.. _known_issues_other:

Other issues
============

Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/libraries/bluetooth_services/services/ddfs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
************

Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/libraries/networking/azure_fota.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
*************
Expand Down
2 changes: 1 addition & 1 deletion doc/nrf/libraries/networking/lwm2m_client_utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 3 additions & 0 deletions doc/nrf/libraries/others/dm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
********

Expand Down
8 changes: 7 additions & 1 deletion doc/nrf/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@
.. _`Installing on Linux`: https://nrfconnect.github.io/vscode-nrf-connect/connect/install.html#installing-on-linux
.. _`Creating an application`: https://nrfconnect.github.io/vscode-nrf-connect/connect/create_app.html
.. _`Building an application`: https://nrfconnect.github.io/vscode-nrf-connect/connect/build_app.html
.. _`Building nRF Connect SDK application quick guide`: https://nrfconnect.github.io/vscode-nrf-connect/connect/build_app_ncs.html
.. _`Testing an application`: https://nrfconnect.github.io/vscode-nrf-connect/connect/test_app.html
.. _`Debugging an application`: https://nrfconnect.github.io/vscode-nrf-connect/connect/debug_app.html
.. _`West integration`: https://nrfconnect.github.io/vscode-nrf-connect/connect/west.html
Expand All @@ -160,6 +161,7 @@
.. _`nRF Connect SDK latest documentation`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/index.html

.. _`known issues page on the main branch`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html
.. _`known issues for nRF Connect SDK v2.1.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html?v=v2-1-0
.. _`known issues for nRF Connect SDK v2.0.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html?v=v2-0-2
.. _`known issues for nRF Connect SDK v2.0.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html?v=v2-0-1
.. _`known issues for nRF Connect SDK v2.0.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/nrf/known_issues.html?v=v2-0-0
Expand Down Expand Up @@ -227,20 +229,23 @@
.. _`TF-M documentation`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/tfm/index.html
.. _`TF-M secure partition integration guide`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/latest/tfm/docs/integration_guide/services/tfm_secure_partition_addition.html

.. _`Repositories and revisions for v2.1.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.1.0/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions for v2.0.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.2/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions for v2.0.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.1/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions for v2.0.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.0/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions for v1.9.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.2/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions for v1.9.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.1/nrf/introduction.html#repositories-and-revisions
.. _`Repositories and revisions`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.0/nrf/introduction.html#repositories-and-revisions

.. _`Modem library changelog for v2.1.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.1.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.0.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.2/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.0.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.1/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v2.0.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v1.9.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.2/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v1.9.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.1/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog
.. _`Modem library changelog for v1.9.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/1.9.0/nrfxlib/nrf_modem/doc/CHANGELOG.html#nrf-modem-changelog

.. _`LwM2M carrier library changelog for v2.1.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.1.0/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.0.2`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.2/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.0.1`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.1/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
.. _`LwM2M carrier library changelog for v2.0.0`: https://developer.nordicsemi.com/nRF_Connect_SDK/doc/2.0.0/nrf/libraries/bin/lwm2m_carrier/CHANGELOG.html#liblwm2m-carrier-changelog
Expand Down Expand Up @@ -304,9 +309,10 @@

.. _`iBasis network coverage spreadsheet`: https://www.nordicsemi.com/-/media/Software-and-other-downloads/3rd-party/iBasis-simplified-coverage-map-for-web.pdf?la=en&hash=CA7DBF400243D8A7A7BDA94873B50E73C26B4FAC

.. _`nRF Connect SDK v2.1.0 webinar`: https://www.nordicsemi.com/Events/2022/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v210?utm_campaign=2022%20Webinars&utm_source=Documentation&utm_medium=Link%20to%20webinar%20%7C%20from%20documentation&utm_content=Link%20to%20webinar%20%7C%20from%20documentation
.. _`nRF Connect SDK v2.0.0 webinar`: https://www.nordicsemi.com/Events/2022/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v2?utm_campaign=2022%20Webinars&utm_source=developer.nordicsemi.com&utm_medium=Webinar%20registration%20%7C%20nRF%20Connect%20SDK%20v2.0&utm_content=Webinar%20registration%20%7C%20nRF%20Connect%20SDK%20v2.0
.. _`nRF Connect SDK v1.9.0 webinar`: https://www.nordicsemi.com/Events/2022/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v19?utm_campaign=2022%20Webinars&utm_source=developer.nordicsemi.com&utm_medium=In-line%20text%20%7C%20nRF%20Connect%20SDK%20v1.9%20%7C%20Link%20to%20webinar

.. _`nRF Connect SDK v2.0.0 webinar`: https://www.nordicsemi.com/Events/2022/Webinar-Exciting-new-features-in-nRF-Connect-SDK-v2?utm_campaign=2022%20Webinars&utm_source=developer.nordicsemi.com&utm_medium=Webinar%20registration%20%7C%20nRF%20Connect%20SDK%20v2.0&utm_content=Webinar%20registration%20%7C%20nRF%20Connect%20SDK%20v2.0

.. _`Contact Us`: https://www.nordicsemi.com/About-us/Contact-Us
.. _`Nordic Semiconductor Wi-Fi products`: https://www.nordicsemi.com/Products/WiFi
Expand Down
5 changes: 2 additions & 3 deletions doc/nrf/release_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,16 @@ 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 aspects:
When looking at this latest documentation, be aware of the following aspect:

* 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 right-hand corner.

.. toctree::
:maxdepth: 1
:caption: Subpages:

releases/release-notes-changelog
releases/release-notes-2.1.0
umapraseeda marked this conversation as resolved.
Show resolved Hide resolved
releases/release-notes-2.0.2
releases/release-notes-2.0.1
releases/release-notes-2.0.0
Expand Down
Loading