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.

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: Matter: Add shared configurations page #19046

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

wiba-nordic
Copy link
Contributor

The Matter samples share some configurations. In the case of the Kconfig options, these are not picked up by the docs build system. This adds a separate page where these options are documented.

@wiba-nordic wiba-nordic added doc-required PR must not be merged without tech writer approval. doc only labels Nov 25, 2024
@wiba-nordic wiba-nordic requested a review from a team November 25, 2024 08:15
@wiba-nordic wiba-nordic requested review from a team as code owners November 25, 2024 08:15
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Nov 25, 2024

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 4

Inputs:

Sources:

sdk-nrf: PR head: 02e9c2b385df30715cf16820c0850a993020baa7

more details

sdk-nrf:

PR head: 02e9c2b385df30715cf16820c0850a993020baa7
merge base: 6039f938fdae291fb27bb282ab79360ab488146a
target head (main): c2f26f33bcf1d9a0a35da4e55343be21759eef94
Diff

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 (13)
applications
│  ├── matter_bridge
│  │  ├── doc
│  │  │  │ matter_bridge_description.rst
doc
│  ├── nrf
│  │  ├── protocols
│  │  │  ├── matter
│  │  │  │  ├── end_product
│  │  │  │  │  ├── test_event_triggers.rst
│  │  │  │  │  │ watchdog.rst
│  │  │  │  ├── getting_started
│  │  │  │  │  ├── advanced_kconfigs.rst
│  │  │  │  │  ├── low_power_configuration.rst
│  │  │  │  │  │ memory_optimization.rst
│  │  ├── releases_and_maturity
│  │  │  ├── known_issues.rst
│  │  │  ├── migration
│  │  │  │  │ migration_guide_2.6.rst
│  │  │  ├── releases
│  │  │  │  ├── release-notes-2.6.0.rst
│  │  │  │  │ release-notes-changelog.rst
│  │  ├── samples
│  │  │  │ matter.rst
samples
│  ├── matter
│  │  ├── common
│  │  │  │ config.rst
│  │  ├── lock
│  │  │  │ README.rst

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
    • ◻️ test-fw-nrfconnect-chip
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-boot
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • test-fw-nrfconnect-nrf-iot_nrf_provisioning
    • test-fw-nrfconnect-nrf-iot_positioning
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-sidewalk
    • test-sdk-wifi
    • test-secdom-samples-public

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

@NordicBuilder
Copy link
Contributor

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

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

samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
samples/matter/common/config.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@peknis peknis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a nit.

@@ -270,15 +270,15 @@ The logs are not removed after reading, but when attempting to write new logs to

The diagnostic network and end user logs are designed to be pushed when requested by the user.
This can result in the same information being passed by multiple APIs, which is usually not desirable behavior.
Because of this, for the network and the end user logs the :kconfig:option:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT` Kconfig option is enabled by default.
Because of this, for the network and the end user logs the :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT>` Kconfig option is enabled by default.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Because of this, for the network and the end user logs the :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT>` Kconfig option is enabled by default.
Because of this, for the network and the end-user logs the :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_REDIRECT>` Kconfig option is enabled by default.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Applied to a couple of other places in the same file as well.

The Matter samples share some configurations. In the case of
the Kconfig options, these are not picked up by the docs build
system. This adds a separate page where these options are documented.

Signed-off-by: Wille Backman <wille.backman@nordicsemi.no>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants