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: OS support: update table #17214

Merged
merged 1 commit into from
Oct 14, 2024

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Sep 6, 2024

Updated table with the finalized input received from stakeholders. NCSDK-29043.


  • Remove TBDs from tables. Info from @shanthanordic : "more information is expected in Sep. macOS15 release is in Oct time frame."

@greg-fer greg-fer added doc-required PR must not be merged without tech writer approval. CI-disable Disable CI for this PR doc only labels Sep 6, 2024
@greg-fer greg-fer added this to the 2.8.0 milestone Sep 6, 2024
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Sep 6, 2024
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Sep 6, 2024

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: d6770222a7938ae9d6f4360d2f578517fa0a5eed

more details

sdk-nrf:

PR head: d6770222a7938ae9d6f4360d2f578517fa0a5eed
merge base: 9418b891fc38d7b4bd7be2688e8cf73bee0ab4e5
target head (main): 7783dec68487595b5a90daec5220b3135eded402
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 (9)
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── nrf53
│  │  │  │  │  │ building_nrf53.rst
│  │  │  │  ├── working_with_nrf
│  │  │  │  │  ├── nrf54h
│  │  │  │  │  │  │ ug_nrf54h20_gs.rst
│  │  ├── installation
│  │  │  ├── install_ncs.rst
│  │  │  │ recommended_versions.rst
│  │  ├── links.txt
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  ├── nRF54H20_migration_2.7
│  │  │  │  │  ├── migration_guide_2.6.99-cs2_to_2_7_environment.rst
│  │  │  │  │  │ transition_guide_2.4.99-cs3_to_2.7_environment.rst
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst
│  │  │ shortcuts.txt

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_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-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

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from 76f383b to 48bf4c0 Compare September 6, 2024 07:02
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Sep 6, 2024
@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch 2 times, most recently from a20986f to 0bffd4b Compare September 6, 2024 09:58
@greg-fer greg-fer marked this pull request as draft September 6, 2024 09:59
@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 Publishing GitHub Action.

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch 2 times, most recently from 6f21b24 to 19a0d01 Compare September 20, 2024 11:07
@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch 3 times, most recently from e0561be to e8fd38e Compare September 20, 2024 15:19
@greg-fer greg-fer marked this pull request as ready for review September 23, 2024 14:49
@greg-fer greg-fer requested review from a team as code owners September 23, 2024 14:49
@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from f6fa8ae to b1d10f0 Compare October 3, 2024 09:54
@greg-fer
Copy link
Contributor Author

greg-fer commented Oct 3, 2024

Pending conversation results between myself, Kari, and Shantha.

Summary of discussed changes:

  • Have only 1 table with OS support for FW and remove the tier definitions -- this is to keep it short and clear and within the context of the SDK
  • Move the OS support for tools to their own documentation and link to there (nRF Util) -- this is because tools means just nRF Util, VS Code extension, and nRF Connect for Desktop (which both use nRF Util), not the entirety of the toolchain

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch 4 times, most recently from 15ef49a to 17389a6 Compare October 3, 2024 13:59
@thst-nordic thst-nordic self-requested a review October 4, 2024 08:32
Copy link
Contributor

@thst-nordic thst-nordic left a comment

Choose a reason for hiding this comment

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

simplified table looks good.

doc/nrf/installation/recommended_versions.rst Outdated Show resolved Hide resolved
@greg-fer greg-fer marked this pull request as ready for review October 4, 2024 08:48
- Built and tested with :ref:`Twister <running_unit_tests>`.
- Not supported.
* - `Linux - Ubuntu 22.04 LTS`_
- Built and tested with :ref:`Twister <running_unit_tests>`. Comprehensive testing with Nordic Semicondutor hardware.
Copy link
Contributor

Choose a reason for hiding this comment

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

Semicondutor --> Semiconductor

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from 17389a6 to 7c03afe Compare October 4, 2024 09:25
@greg-fer greg-fer added the DNM label Oct 8, 2024
@greg-fer
Copy link
Contributor Author

greg-fer commented Oct 8, 2024

Pending an update from @shanthanordic on Thursday, Oct 10, 9 am.

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch 4 times, most recently from 6f90c7c to 9d6a769 Compare October 12, 2024 17:36
@greg-fer
Copy link
Contributor Author

The latest edit applies the following changes:

  • Firmware table placed on top

    image

  • Table for nRF Util, nRF CfDesktop, and consequently VSC extension placed in the section that mentions these tools at the bottom of the page -- there is also a new section about Toolchain Manager there, because it is that tool in nRF Connect for Desktop that needs this table.

    image

Reasons why I did not place the tools table first and firmware table after tools, smaller, at the top of the page:

  • "tools" has been misinterpreted several times by different people to be referring to toolchain's required tools and Python dependencies
  • placing the tools table before the toolchain and Python dependencies sections does not solve this confusion
  • rephrasing "tools" to "nRF Util, VSC, nRF Connect for Desktop" does not help either if the table is still placed before the toolchain and Python dependencies sections -- it will make people think that all these three tools are required by the NCS
  • having table for tools and then table for firmware in the SDK documentation that is all about firmware makes no logical sense to me

Copy link

@shanthanordic shanthanordic left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@chunfantasy chunfantasy left a comment

Choose a reason for hiding this comment

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

LGTM

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from 9d6a769 to 331c98d Compare October 14, 2024 12:04
doc/nrf/installation/recommended_versions.rst Outdated Show resolved Hide resolved
doc/nrf/shortcuts.txt Outdated Show resolved Hide resolved
@@ -243,3 +243,6 @@

.. |ATv2_maintenance_note| replace:: The Asset Tracker v2 application is in maintenance mode.
For new projects, it is recommended to use the :ref:`nrf_cloud_multi_service` sample instead.

.. |toolchain_management_ncs_versions| replace:: The Toolchain Manager installation is recommended only when using the nRF54H20 DK with the |NCS| v2.7.0.
Copy link
Contributor

Choose a reason for hiding this comment

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

Should "v2.7.0" be replaced with "|release|"? Or is that supposed to be left only for v2.7.0?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Only for v2.7.0, AFAIK -- info from @FrancescoSer .

@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from 331c98d to 5e420ed Compare October 14, 2024 12:24
@greg-fer greg-fer removed the DNM label Oct 14, 2024
Updated table with input received from stakeholders.
Updated definitions based on receved feedback.
NCSDK-29043.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
@greg-fer greg-fer force-pushed the doc_update_supported_platforms branch from 5e420ed to d677022 Compare October 14, 2024 12:28
@rlubos rlubos merged commit 7783dec into nrfconnect:main Oct 14, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI-disable Disable CI for this PR 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.