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: 3.0.0-preview1 doc updates #20615

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

Conversation

umapraseeda
Copy link
Contributor

Pre-release version updates for 3.0.0-preview1.
Before merging, the target branch should be
changed to the preview branch once it is created.

@umapraseeda umapraseeda requested review from a team as code owners February 26, 2025 09:45
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Feb 26, 2025
Copy link

After documentation is built, you will find the preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/index.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/known_issues.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.5.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.6.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.7.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.8.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1-rc2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.9.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_3.0.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_spm_to_tf-m.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_hwmv2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_sysbuild.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration_guides.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/releases/release-notes-changelog.html

@NordicBuilder
Copy link
Contributor

NordicBuilder commented Feb 26, 2025

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 933caf10729c18cb08138d27a21113cd8fe5b199

more details

sdk-nrf:

PR head: 933caf10729c18cb08138d27a21113cd8fe5b199
merge base: 72a34fe06d2b3fcf272e6297dfa5b37de3919e76
target head (main): d061d80c349424e7825264143a150a9f53fb1791
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 (24)
doc
│  ├── nrf
│  │  ├── dev_model_and_contributions
│  │  │  │ adding_code.rst
│  │  ├── index.rst
│  │  ├── links.txt
│  │  ├── releases_and_maturity.rst
│  │  ├── releases_and_maturity
│  │  │  ├── known_issues.rst
│  │  │  ├── migration
│  │  │  │  ├── migration_guide_1.x_to_2.x.rst
│  │  │  │  ├── migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst
│  │  │  │  ├── migration_guide_2.5.rst
│  │  │  │  ├── migration_guide_2.6.rst
│  │  │  │  ├── migration_guide_2.7.rst
│  │  │  │  ├── migration_guide_2.8.rst
│  │  │  │  ├── migration_guide_2.9.0-nRF54H20-1-rc2.rst
│  │  │  │  ├── migration_guide_2.9.rst
│  │  │  │  ├── migration_guide_3.0.rst
│  │  │  │  ├── migration_guide_nRF54H20_cs_to_2_7.rst
│  │  │  │  ├── migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
│  │  │  │  ├── migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst
│  │  │  │  ├── migration_guide_spm_to_tf-m.rst
│  │  │  │  ├── migration_hwmv2.rst
│  │  │  │  │ migration_sysbuild.rst
│  │  │  ├── migration_guides.rst
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst
│  │  │ shortcuts.txt
│  │ versions.json

Outputs:

Toolchain

Version:
Build docker image:

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

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
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-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_mosh
    • 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-proprietary_esb
    • 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

@umapraseeda umapraseeda force-pushed the 300_preview1_prerelease_doc_updates branch from 664d5b7 to 7c5dd28 Compare February 26, 2025 09:51
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 tentative suggestion.

@@ -4,6 +4,11 @@
Introduction
############

.. important::

|NCS| v3.0.0-preview1 is a development tag used for development purposes but is not recommended to use in a production environment.
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
|NCS| v3.0.0-preview1 is a development tag used for development purposes but is not recommended to use in a production environment.
|NCS| v3.0.0-preview1 is a development tag used only for development purposes.

Would this be sufficient?

Pre-release version updates for 3.0.0-preview1

Signed-off-by: Uma Praseeda <[email protected]>
@umapraseeda umapraseeda force-pushed the 300_preview1_prerelease_doc_updates branch from 7c5dd28 to 933caf1 Compare February 26, 2025 10:59
@umapraseeda umapraseeda requested a review from a team as a code owner February 26, 2025 10:59
Copy link

You can find the documentation preview for this PR here.

Preview links for modified nRF Connect SDK documents:

https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/dev_model_and_contributions/adding_code.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/index.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/known_issues.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.5.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.6.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.7.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.8.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1-rc2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_2.9.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_3.0.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_guide_spm_to_tf-m.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_hwmv2.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration/migration_sysbuild.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/migration_guides.html
https://ncsdoc.z6.web.core.windows.net/PR-20615/nrf/releases_and_maturity/releases/release-notes-changelog.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants