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: install_ncs: minor improvements #20240

Merged

Conversation

greg-fer
Copy link
Contributor

@greg-fer greg-fer commented Feb 7, 2025

Added direct links to Downloads in install_ncs/Installing prerequisites. Fixed a line for J-Link version in recommended_versions. TECHDOC-3429.

@greg-fer greg-fer added CI-disable Disable CI for this PR doc only labels Feb 7, 2025
@greg-fer greg-fer added this to the 3.0.0 milestone Feb 7, 2025
@greg-fer greg-fer requested review from a team as code owners February 7, 2025 10:59
@github-actions 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 Feb 7, 2025
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 7, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Feb 7, 2025

CI Information

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

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

@NordicBuilder
Copy link
Contributor

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

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

@greg-fer greg-fer force-pushed the doc_jlink_reccomended_versions_fix branch from 869a37e to e977009 Compare February 7, 2025 13:56
@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 Feb 7, 2025
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 7, 2025
@pascal-nordic
Copy link
Contributor

I tried to install west system wide using Linux command line with the instruction in the manual:

pip3 install --user -U west

but I got:

image

@greg-fer
Copy link
Contributor Author

greg-fer commented Feb 9, 2025

I tried to install west system wide using Linux command line with the instruction in the manual:

pip3 install --user -U west

but I got:

image

Sorry, this is not relevant to this PR. Please report this on NCS > General on Teams.

Copy link
Contributor

Choose a reason for hiding this comment

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

On the step 5 from Command line in "Get the nRF Connect SDK code", it should specify the the user needs to enter the folder that just got with west init and then run west update. It will fail if the user does it from ncs

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Fixed.

Added direct links to Downloads in install_ncs/Installing prerequisites.
Fixed a line for J-Link version in recommended_versions.
Fixed a missing reference to an subdir in one step.
Added "Alternative method" to two sections to clearly mark they are
separate from the main installation method.
TECHDOC-3429.

Signed-off-by: Grzegorz Ferenc <[email protected]>
@greg-fer greg-fer force-pushed the doc_jlink_reccomended_versions_fix branch from e977009 to a7dd269 Compare February 10, 2025 12:24
@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 Feb 10, 2025
@greg-fer greg-fer removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Feb 10, 2025
@nordicjm nordicjm merged commit 085e0ac into nrfconnect:main Feb 10, 2025
14 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.

7 participants