doc: Harmonize linux sdk install docs + add udev rules guide to other linux distro guide #89896
Conversation
Harmonize the sdk install part of the "install linux host dependencies" with the common sdk installation guide under develop/toolchains/zephyr_sdk.html. - Add udev rules installation guide - Relocate some notes Signed-off-by: Aymeric Aillet <[email protected]>
aaillet
changed the title
|
There was a problem hiding this comment.
Harmonize the sdk install part of the "install linux host dependencies" with the common sdk installation guide under develop/toolchains/zephyr_sdk.html.
"Harmonize" as-in "copy-paste" (not blaming you at all! you just followed what was already there) :| Not sure why I never realized we had duplicated content before.
The "Install the Zephyr Software Development Kit (SDK)" section should really just send the reader to https://docs.zephyrproject.org/latest/develop/toolchains/zephyr_sdk.html#zephyr-sdk-installation -- no ?
Yep, exactly 😄
It would indeed solve the lack of information and simplify maintenance, but do we want links between docs in this kind of guide? This could spoil the user experience. I say this because, to simplify maintenance even further, we could also link to this page in the main “getting started” section when talking about SDK installation, but I don't think that's advisable. |
|
So, from your POV @kartben, should I move sdk installation guide for all operating systems (Ubuntu,macOS,Windows,Fedora,Clear Linux,Arch Linux) to https://docs.zephyrproject.org/latest/develop/toolchains/zephyr_sdk.html#zephyr-sdk-installation and just put a link to it here https://docs.zephyrproject.org/latest/develop/getting_started/installation_linux.html#install-the-zephyr-software-development-kit-sdk ? We may keep the current "base" sdk installation guide in the getting started guide or make it a link too later Thanks for your answers |
|
This pull request has been marked as stale because it has been open (more than) 60 days with no activity. Remove the stale label or add a comment saying that you would like to have the label removed otherwise this pull request will automatically be closed in 14 days. Note, that you can always re-open a closed pull request at any time. |
|
Hmm, forgot this, I'll check current status since 4.2 release and edit my changes 👍 |
While following the "install linux host dependencies" guide to install Zephyr and it's dependencies on a fresh Fedora 41 install, when I first tried flashing a firmware on a board, I realized that the part of the guide concerning the installation of the udev rule was missing.
I think that it could be a bit harsh for a new user to find out what's the problem.
As a regular Zephyr user, I'm not using the
west sdk installcommand but it could also be a way to rework this doc to use it instead (if it include the udev rule installation commands) if the solution i proposed is not following the current documentation spirit.Harmonize the sdk install part of the "install linux host dependencies" with the common sdk installation guide under develop/toolchains/zephyr_sdk.html.