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

Merged

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: 6

Inputs:

Sources:

sdk-nrf: PR head: 1c1127e31f6e599b79af38c8273b52eec6d0a0c7

more details

sdk-nrf:

PR head: 1c1127e31f6e599b79af38c8273b52eec6d0a0c7
merge base: c3f89ebef03e1869d2f9efae9d9a8d73bdcc702e
target head (main): 364b25fe0f17171d9ebdda0e2e18d1de68f4568f
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 (14)
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
│  │  │  │  │ migration_guide_2.9.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

@wiba-nordic wiba-nordic force-pushed the doc-matter-common-kconfig branch from a66b0b6 to 0bf0b5d Compare November 25, 2024 08:20
@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
@wiba-nordic wiba-nordic force-pushed the doc-matter-common-kconfig branch from 0bf0b5d to 013f158 Compare November 25, 2024 09:02
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.

@wiba-nordic wiba-nordic force-pushed the doc-matter-common-kconfig branch from 013f158 to 02e9c2b Compare November 25, 2024 11:00
@wiba-nordic wiba-nordic force-pushed the doc-matter-common-kconfig branch from 02e9c2b to 240fca4 Compare December 3, 2024 10:45
@wiba-nordic
Copy link
Contributor Author

Added watchdog pause-related Kconfig options.

Copy link
Contributor

@ArekBalysNordic ArekBalysNordic left a comment

Choose a reason for hiding this comment

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

Looks great!

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 <[email protected]>
@wiba-nordic wiba-nordic force-pushed the doc-matter-common-kconfig branch from 240fca4 to 1c1127e Compare December 4, 2024 11:28
@wiba-nordic
Copy link
Contributor Author

Formatted the two bridge device data migration Kconfigs to match the new format added in this PR, and moved them a bit higher so it doesn't seem like they affect the number of bridges devices.

@wiba-nordic
Copy link
Contributor Author

If the build clears without issues, should be good to merge.

@ArekBalysNordic ArekBalysNordic merged commit dda18fe into nrfconnect:main Dec 4, 2024
13 checks passed
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.

4 participants