doc: add-ons: add information about the index #19880

greg-fer · 2025-01-13T15:49:54Z

Added mentions of the nRF Connect SDK Add-ons page and the ncs-app-index repository to the pages Create an application and Integrations. Added a glossary entry.
VSC-2765.

NordicBuilder · 2025-01-13T15:54:14Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 5

Inputs:

Sources:

more details

Github labels

Enabled	Name	Description
	ci-disabled	Disable the ci execution
	ci-all-test	Run all of ci, no test spec filtering will be done
	ci-force-downstream	Force execution of downstream even if twister fails
	ci-run-twister	Force run twister
	ci-run-zephyr-twister	Force run zephyr twister

List of changed files detected by CI (0)

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

◻️ Toolchain
◻️ Build twister
◻️ Integration tests

Note: This message is automatically posted and updated by the CI

peknis · 2025-01-14T06:44:34Z

doc/nrf/app_dev/create_application.rst

+
+   .. tab:: nRF Connect for VS Code (recommended)
+
+      The add-on applications can be created using the following steps in the |nRFVSC|:


Suggested change

The add-on applications can be created using the following steps in the |nRFVSC|:

Complete the following steps in the |nRFVSC|:

peknis · 2025-01-14T06:45:14Z

doc/nrf/app_dev/create_application.rst

+   .. tab:: Command line
+
+      When creating add-on applications from the command line, follow the instructions provided in the `nRF Connect SDK Add-ons`_ repository.
+      These instructions will guide you through the process of copying and configuring the add-on application in your workspace.


Suggested change

These instructions will guide you through the process of copying and configuring the add-on application in your workspace.

These instructions guide you through the process of copying and configuring the add-on application in your workspace.

peknis · 2025-01-14T06:45:42Z

doc/nrf/app_dev/create_application.rst

+      When creating add-on applications from the command line, follow the instructions provided in the `nRF Connect SDK Add-ons`_ repository.
+      These instructions will guide you through the process of copying and configuring the add-on application in your workspace.
+
+The add-on will be copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.


Suggested change

The add-on will be copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.

The add-on is copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.

peknis · 2025-01-14T06:46:53Z

doc/nrf/app_dev/create_application.rst

+
+The add-on will be copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.
+
+For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.


Suggested change

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` documents in the `ncs-app-index repository <ncs-app-index_>`_.

peknis · 2025-01-14T06:48:29Z

doc/nrf/glossary.rst

+      The index can be accessed from the |nRFVSC|, and can also be browsed on `add-on webpage <nRF Connect SDK Add-ons_>`_.
+      Add-ons in the index follow specific contribution guidelines and are maintained by their respective owners.
+      The workspace applications listed there can be used to create out-of-tree :ref:`workspace applications <creating_add_on_index>`.
+      For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.


Suggested change

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` documents in the `ncs-app-index repository <ncs-app-index_>`_.

peknis · 2025-01-14T06:48:52Z

doc/nrf/integrations.rst

@@ -11,6 +11,10 @@ Integrations of the following third-party products are documented in their priva

 In the case of Find My, MFi licensees can get access to the repository by issuing a Nordic `DevZone`_ private ticket.

+.. note::
+    Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page, which provides a curated collection of supplementary |NCS| components.


Suggested change

Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page, which provides a curated collection of supplementary |NCS| components.

Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page that provides a curated collection of supplementary |NCS| components.

peknis · 2025-01-14T06:49:07Z

doc/nrf/integrations.rst

@@ -11,6 +11,10 @@ Integrations of the following third-party products are documented in their priva

 In the case of Find My, MFi licensees can get access to the repository by issuing a Nordic `DevZone`_ private ticket.

+.. note::
+    Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page, which provides a curated collection of supplementary |NCS| components.
+    For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.


Suggested change

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.

For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` documents in the `ncs-app-index repository <ncs-app-index_>`_.

NordicBuilder · 2025-01-14T09:38:57Z

You can find the documentation preview for this PR at this link.

Note: This comment is automatically posted by the Documentation Publish GitHub Action.

doc/nrf/glossary.rst

doc/nrf/integrations.rst

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst

FilipZajdel

Looks good.

Added mentions of the nRF Connect SDK Add-ons page and the ncs-app-index repository to the pages Create an application and Integrations. Added a glossary entry. VSC-2765. Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer added CI-disable Disable CI for this PR doc only labels Jan 13, 2025

greg-fer added this to the 3.0.0 milestone Jan 13, 2025

greg-fer requested a review from FilipZajdel January 13, 2025 15:49

greg-fer requested review from a team as code owners January 13, 2025 15:49

github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jan 13, 2025

greg-fer force-pushed the doc_add_info_about_addon_index branch from f3f6a6a to 4a58430 Compare January 13, 2025 15:53

greg-fer requested a review from a team as a code owner January 13, 2025 15:53

github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jan 13, 2025

peknis requested changes Jan 14, 2025

View reviewed changes

greg-fer force-pushed the doc_add_info_about_addon_index branch 2 times, most recently from 4dae2f7 to 5f1ad3b Compare January 14, 2025 09:21

greg-fer requested a review from a team as a code owner January 14, 2025 09:21

annwoj approved these changes Jan 14, 2025

View reviewed changes

greg-fer requested a review from peknis January 14, 2025 12:48

peknis approved these changes Jan 14, 2025

View reviewed changes

umapraseeda reviewed Jan 14, 2025

View reviewed changes

doc/nrf/glossary.rst Show resolved Hide resolved

doc/nrf/integrations.rst Outdated Show resolved Hide resolved

doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst Outdated Show resolved Hide resolved

FilipZajdel approved these changes Jan 14, 2025

View reviewed changes

greg-fer requested a review from wbober January 14, 2025 14:24

doc: add-ons: add information about the index

4cb3d41

Added mentions of the nRF Connect SDK Add-ons page and the ncs-app-index repository to the pages Create an application and Integrations. Added a glossary entry. VSC-2765. Signed-off-by: Grzegorz Ferenc <[email protected]>

greg-fer force-pushed the doc_add_info_about_addon_index branch from 5f1ad3b to 4cb3d41 Compare January 14, 2025 14:28

umapraseeda approved these changes Jan 14, 2025

View reviewed changes

wbober approved these changes Jan 16, 2025

View reviewed changes

rlubos approved these changes Jan 16, 2025

View reviewed changes

rlubos merged commit 458b9a1 into nrfconnect:main Jan 16, 2025
13 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: add-ons: add information about the index #19880

doc: add-ons: add information about the index #19880

greg-fer commented Jan 13, 2025

NordicBuilder commented Jan 13, 2025 •

edited

Loading

peknis Jan 14, 2025

peknis Jan 14, 2025

peknis Jan 14, 2025

peknis Jan 14, 2025

peknis Jan 14, 2025

peknis Jan 14, 2025

peknis Jan 14, 2025

NordicBuilder commented Jan 14, 2025

FilipZajdel left a comment


		.. tab:: nRF Connect for VS Code (recommended)

		The add-on applications can be created using the following steps in the \|nRFVSC\|:

	The add-on applications can be created using the following steps in the \|nRFVSC\|:
	Complete the following steps in the \|nRFVSC\|:

	These instructions will guide you through the process of copying and configuring the add-on application in your workspace.
	These instructions guide you through the process of copying and configuring the add-on application in your workspace.

	The add-on will be copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.
	The add-on is copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.


		The add-on will be copied to your workspace and automatically configured with a west workspace, allowing you to start development right away.

		For more information, including how to contribute your own add-on to the index, read the :file:`README.md` and :file:`CONTRIBUTING.md` files in the `ncs-app-index repository <ncs-app-index_>`_.

	Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page, which provides a curated collection of supplementary \|NCS\| components.
	Some of these integrations are available through the `nRF Connect SDK Add-ons`_ page that provides a curated collection of supplementary \|NCS\| components.

doc: add-ons: add information about the index #19880

doc: add-ons: add information about the index #19880

Conversation

greg-fer commented Jan 13, 2025

NordicBuilder commented Jan 13, 2025 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

peknis Jan 14, 2025

Choose a reason for hiding this comment

NordicBuilder commented Jan 14, 2025

FilipZajdel left a comment

Choose a reason for hiding this comment

NordicBuilder commented Jan 13, 2025 •

edited

Loading